diff --git a/docs/modules/ROOT/pages/README.adoc b/docs/modules/ROOT/pages/README.adoc index 720fe7dc08..3bb7a70cf1 100644 --- a/docs/modules/ROOT/pages/README.adoc +++ b/docs/modules/ROOT/pages/README.adoc @@ -1,5 +1,6 @@ [[spring-cloud-contract]] = Spring Cloud Contract +:page-section-summary-toc: 1 You always need confidence when pushing new features into a new application or service in a distributed system. To that end, this project provides support for consumer-driven @@ -9,11 +10,13 @@ producers and consumers -- for both HTTP and message-based interactions. [[project-page]] = Project page +:page-section-summary-toc: 1 You can read more about Spring Cloud Contract by going to https://spring.io/projects/spring-cloud-contract[the project page] [[contributing]] = Contributing +:page-section-summary-toc: 1 include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/docs/src/main/asciidoc/contributing.adoc[] diff --git a/docs/modules/ROOT/pages/_index.adoc b/docs/modules/ROOT/pages/_index.adoc index b00dfa5963..b2a57fca62 100644 --- a/docs/modules/ROOT/pages/_index.adoc +++ b/docs/modules/ROOT/pages/_index.adoc @@ -1,5 +1,6 @@ [[spring-cloud-contract-reference-documentation]] = Spring Cloud Contract Reference Documentation +:page-section-summary-toc: 1 Adam Dudczak, Mathias Düsterhöft, Marcin Grzejszczak, Dennis Kieselhorst, Jakub Kubryński, Karol Lassak, Olga Maciaszek-Sharma, Mariusz Smykuła, Dave Syer, Jay Bryant :docinfo: shared diff --git a/docs/modules/ROOT/pages/_index_pdf.adoc b/docs/modules/ROOT/pages/_index_pdf.adoc index 72db7409e8..07072dfaa3 100644 --- a/docs/modules/ROOT/pages/_index_pdf.adoc +++ b/docs/modules/ROOT/pages/_index_pdf.adoc @@ -1,5 +1,6 @@ [[spring-cloud-contract-reference-documentation]] = Spring Cloud Contract Reference Documentation +:page-section-summary-toc: 1 Adam Dudczak, Mathias Düsterhöft, Marcin Grzejszczak, Dennis Kieselhorst, Jakub Kubryński, Karol Lassak, Olga Maciaszek-Sharma, Mariusz Smykuła, Dave Syer, Jay Bryant diff --git a/docs/modules/ROOT/pages/_index_single.adoc b/docs/modules/ROOT/pages/_index_single.adoc index d3aa080ff6..332ec80b0b 100644 --- a/docs/modules/ROOT/pages/_index_single.adoc +++ b/docs/modules/ROOT/pages/_index_single.adoc @@ -1,5 +1,6 @@ [[spring-cloud-contract-reference-documentation]] = Spring Cloud Contract Reference Documentation +:page-section-summary-toc: 1 Adam Dudczak, Mathias Düsterhöft, Marcin Grzejszczak, Dennis Kieselhorst, Jakub Kubryński, Karol Lassak, Olga Maciaszek-Sharma, Mariusz Smykuła, Dave Syer, Jay Bryant :docinfo: shared diff --git a/docs/modules/ROOT/pages/_project-features-contract/groovy.adoc b/docs/modules/ROOT/pages/_project-features-contract/groovy.adoc index f68322470b..640b9a8f97 100644 --- a/docs/modules/ROOT/pages/_project-features-contract/groovy.adoc +++ b/docs/modules/ROOT/pages/_project-features-contract/groovy.adoc @@ -1,5 +1,6 @@ [[contract-groovy]] = Contract DSL in Groovy +:page-section-summary-toc: 1 If you are not familiar with Groovy, do not worry. You can use Java syntax in the Groovy DSL files as well. diff --git a/docs/modules/ROOT/pages/_project-features-contract/limitations.adoc b/docs/modules/ROOT/pages/_project-features-contract/limitations.adoc index 947f1b6686..0191619c34 100644 --- a/docs/modules/ROOT/pages/_project-features-contract/limitations.adoc +++ b/docs/modules/ROOT/pages/_project-features-contract/limitations.adoc @@ -1,5 +1,6 @@ [[contract-limitations]] = Limitations +:page-section-summary-toc: 1 WARNING: The support for verifying the size of JSON arrays is experimental. If you want to turn it on, set the value of the following system property to `true`: diff --git a/docs/modules/ROOT/pages/_project-features-contract/yml.adoc b/docs/modules/ROOT/pages/_project-features-contract/yml.adoc index 64e8309622..3198fc1d10 100644 --- a/docs/modules/ROOT/pages/_project-features-contract/yml.adoc +++ b/docs/modules/ROOT/pages/_project-features-contract/yml.adoc @@ -1,5 +1,6 @@ [[contract-yml]] = Contract DSL in YAML +:page-section-summary-toc: 1 To see a schema of a YAML contract, visit the {docs-url}/reference/html/yml-schema.html[YML Schema] page. diff --git a/docs/modules/ROOT/pages/_project-features-flows.adoc b/docs/modules/ROOT/pages/_project-features-flows.adoc index 409c45d600..027ad53950 100644 --- a/docs/modules/ROOT/pages/_project-features-flows.adoc +++ b/docs/modules/ROOT/pages/_project-features-flows.adoc @@ -1,4 +1,5 @@ [[feature-integrations]] = Integrations +:page-section-summary-toc: 1 diff --git a/docs/modules/ROOT/pages/_project-features-stubrunner.adoc b/docs/modules/ROOT/pages/_project-features-stubrunner.adoc index 619dfb4fad..2e77df4347 100644 --- a/docs/modules/ROOT/pages/_project-features-stubrunner.adoc +++ b/docs/modules/ROOT/pages/_project-features-stubrunner.adoc @@ -1,5 +1,6 @@ [[features-stub-runner]] = Spring Cloud Contract Stub Runner +:page-section-summary-toc: 1 One of the issues that you might encounter while using Spring Cloud Contract Verifier is passing the generated WireMock JSON stubs from the server side to the client side (or to diff --git a/docs/modules/ROOT/pages/_project-features-stubrunner/stub-runner-snapshot-versions.adoc b/docs/modules/ROOT/pages/_project-features-stubrunner/stub-runner-snapshot-versions.adoc index 69379f637f..f1b2725e86 100644 --- a/docs/modules/ROOT/pages/_project-features-stubrunner/stub-runner-snapshot-versions.adoc +++ b/docs/modules/ROOT/pages/_project-features-stubrunner/stub-runner-snapshot-versions.adoc @@ -1,5 +1,6 @@ [[features-stub-runner-snapshot-versions]] = Snapshot Versions +:page-section-summary-toc: 1 You can add the additional snapshot repository to your build file to use snapshot versions, which are automatically uploaded after every successful build, as follows: diff --git a/docs/modules/ROOT/pages/appendix.adoc b/docs/modules/ROOT/pages/appendix.adoc index 09adc42dda..e88632a567 100644 --- a/docs/modules/ROOT/pages/appendix.adoc +++ b/docs/modules/ROOT/pages/appendix.adoc @@ -2,6 +2,7 @@ [appendix] [[common-application-properties]] = Common application properties +:page-section-summary-toc: 1 Various properties can be specified inside your `application.properties` file, inside your `application.yml` file, or as command line switches. diff --git a/docs/modules/ROOT/pages/getting-started.adoc b/docs/modules/ROOT/pages/getting-started.adoc index 8f5ab2b96b..4c0000f239 100644 --- a/docs/modules/ROOT/pages/getting-started.adoc +++ b/docs/modules/ROOT/pages/getting-started.adoc @@ -1,5 +1,6 @@ [[getting-started]] = Getting Started +:page-section-summary-toc: 1 If you are getting started with {project-full-name} or Spring in general, start by reading this section. It answers the basic "`what?`", "`how?`" and "`why?`" questions. It diff --git a/docs/modules/ROOT/pages/howto.adoc b/docs/modules/ROOT/pages/howto.adoc index 189030d926..f266a48551 100644 --- a/docs/modules/ROOT/pages/howto.adoc +++ b/docs/modules/ROOT/pages/howto.adoc @@ -1,5 +1,6 @@ [[howto]] = "`How-to`" Guides +:page-section-summary-toc: 1 This section provides answers to some common "`how do I do that...?`" questions that often arise when using {project-full-name}. Its coverage is not exhaustive, but it diff --git a/docs/modules/ROOT/pages/howto/how-to-debug-wiremock.adoc b/docs/modules/ROOT/pages/howto/how-to-debug-wiremock.adoc index f44ef69450..3c888bcb50 100644 --- a/docs/modules/ROOT/pages/howto/how-to-debug-wiremock.adoc +++ b/docs/modules/ROOT/pages/howto/how-to-debug-wiremock.adoc @@ -1,5 +1,6 @@ [[how-to-debug-wiremock]] = How Can I Debug the Mapping, Request, or Response Being Sent by WireMock? +:page-section-summary-toc: 1 Starting from version `1.2.0`, we set WireMock logging to `info` and set the WireMock notifier to being verbose. Now you can diff --git a/docs/modules/ROOT/pages/howto/how-to-debug.adoc b/docs/modules/ROOT/pages/howto/how-to-debug.adoc index d2902a8bcb..e3cec6df92 100644 --- a/docs/modules/ROOT/pages/howto/how-to-debug.adoc +++ b/docs/modules/ROOT/pages/howto/how-to-debug.adoc @@ -1,5 +1,6 @@ [[how-to-debug]] = How Can I Debug the Request/Response Being Sent by the Generated Tests Client? +:page-section-summary-toc: 1 The generated tests all boil down to RestAssured in some form or fashion. RestAssured relies on the https://hc.apache.org/httpcomponents-client-ga/[Apache HttpClient]. diff --git a/docs/modules/ROOT/pages/howto/how-to-generate-stubs-at-runtime.adoc b/docs/modules/ROOT/pages/howto/how-to-generate-stubs-at-runtime.adoc index b52c548d02..2c8220da33 100644 --- a/docs/modules/ROOT/pages/howto/how-to-generate-stubs-at-runtime.adoc +++ b/docs/modules/ROOT/pages/howto/how-to-generate-stubs-at-runtime.adoc @@ -1,5 +1,6 @@ [[how-to-generate-stubs-at-runtime]] = How Can I Generate Stubs at Runtime +:page-section-summary-toc: 1 If you want to generate stubs at runtime for contracts, switch the `generateStubs` property in the `@AutoConfigureStubRunner` annotation, or call the `withGenerateStubs(true)` method on the JUnit Rule or Extension. You can read more about this in xref:_project-features-stubrunner/stub-runner-generate-stubs-at-runtime.adoc[this section] of the documentation. diff --git a/docs/modules/ROOT/pages/howto/how-to-mark-contract-in-progress.adoc b/docs/modules/ROOT/pages/howto/how-to-mark-contract-in-progress.adoc index b9d54ce8ae..bd19fb5b71 100644 --- a/docs/modules/ROOT/pages/howto/how-to-mark-contract-in-progress.adoc +++ b/docs/modules/ROOT/pages/howto/how-to-mark-contract-in-progress.adoc @@ -1,5 +1,6 @@ [[how-to-mark-contract-in-progress]] = How Can I Mark that a Contract Is in Progress +:page-section-summary-toc: 1 If a contract is in progress, it means that the, on the producer side, tests are not generated, but the stub is generated. You can read more about this in xref:_project-features-contract/common-top-elements.adoc#contract-dsl-in-progress[this section] of the documentation. diff --git a/docs/modules/ROOT/pages/howto/how-to-not-write-contracts-in-groovy.adoc b/docs/modules/ROOT/pages/howto/how-to-not-write-contracts-in-groovy.adoc index b68f9d47ee..89d2f14928 100644 --- a/docs/modules/ROOT/pages/howto/how-to-not-write-contracts-in-groovy.adoc +++ b/docs/modules/ROOT/pages/howto/how-to-not-write-contracts-in-groovy.adoc @@ -1,5 +1,6 @@ [[how-to-not-write-contracts-in-groovy]] = How Can I Write Contracts in a Language Other than Groovy? +:page-section-summary-toc: 1 You can write a contract in YAML. See xref:_project-features-contract.adoc[this section] for more information. diff --git a/docs/modules/ROOT/pages/howto/how-to-reference-text-from-file.adoc b/docs/modules/ROOT/pages/howto/how-to-reference-text-from-file.adoc index a08d567027..601f698386 100644 --- a/docs/modules/ROOT/pages/howto/how-to-reference-text-from-file.adoc +++ b/docs/modules/ROOT/pages/howto/how-to-reference-text-from-file.adoc @@ -1,5 +1,6 @@ [[how-to-reference-text-from-file]] = How Can I Reference Text from File? +:page-section-summary-toc: 1 In version 1.2.0, we added this ability. You can call a `file(...)` method in the DSL and provide a path relative to where the contract lies. diff --git a/docs/modules/ROOT/pages/howto/how-to-see-registered-stubs.adoc b/docs/modules/ROOT/pages/howto/how-to-see-registered-stubs.adoc index 0a3fb04f7f..79e46667e4 100644 --- a/docs/modules/ROOT/pages/howto/how-to-see-registered-stubs.adoc +++ b/docs/modules/ROOT/pages/howto/how-to-see-registered-stubs.adoc @@ -1,5 +1,6 @@ [[how-to-see-registered-stubs]] = How Can I See What Got Registered in the HTTP Server Stub? +:page-section-summary-toc: 1 You can use the `mappingsOutputFolder` property on `@AutoConfigureStubRunner`, `StubRunnerRule`, or `StubRunnerExtension` to dump all mappings for each artifact ID. Also, the port at which the given stub server diff --git a/docs/modules/ROOT/pages/howto/how-to-use-stubs-from-a-location.adoc b/docs/modules/ROOT/pages/howto/how-to-use-stubs-from-a-location.adoc index 79887fae0f..bf7c433b11 100644 --- a/docs/modules/ROOT/pages/howto/how-to-use-stubs-from-a-location.adoc +++ b/docs/modules/ROOT/pages/howto/how-to-use-stubs-from-a-location.adoc @@ -1,5 +1,6 @@ [[how-to-use-stubs-from-a-location]] = How Can I Use Stubs from a Location +:page-section-summary-toc: 1 If you want to fetch contracts or stubs from a given location without cloning a repository or fetching a JAR, use the `stubs://` protocol when providing the repository root argument for Stub Runner or the Spring Cloud Contract plugin. You can read more about this in xref:_project-features-stubrunner/stub-runner-stubs-protocol.adoc[this section] of the documentation. diff --git a/docs/modules/ROOT/pages/howto/how-to-use-the-failonnostubs-feature.adoc b/docs/modules/ROOT/pages/howto/how-to-use-the-failonnostubs-feature.adoc index 126f3f31f5..c0f03aee16 100644 --- a/docs/modules/ROOT/pages/howto/how-to-use-the-failonnostubs-feature.adoc +++ b/docs/modules/ROOT/pages/howto/how-to-use-the-failonnostubs-feature.adoc @@ -1,5 +1,6 @@ [[how-to-use-the-failonnostubs-feature]] = How Can I Make The Build Pass if There Are No Contracts or Stubs +:page-section-summary-toc: 1 If you want Stub Runner not to fail if no stubs were found, switch the `generateStubs` property in the `@AutoConfigureStubRunner` annotation or call the `withFailOnNoStubs(false)` method on the JUnit Rule or Extension. You can read more about this in xref:_project-features-stubrunner/stub-runner-fail-on-no-stubs.adoc[this section] of the documentation. diff --git a/docs/modules/ROOT/pages/howto/why-spring-cloud-contract.adoc b/docs/modules/ROOT/pages/howto/why-spring-cloud-contract.adoc index e1ac69de5c..31effddf75 100644 --- a/docs/modules/ROOT/pages/howto/why-spring-cloud-contract.adoc +++ b/docs/modules/ROOT/pages/howto/why-spring-cloud-contract.adoc @@ -1,5 +1,6 @@ [[why-spring-cloud-contract]] = Why use Spring Cloud Contract? +:page-section-summary-toc: 1 Spring Cloud Contract works great in a polyglot environment. This project has a lot of really interesting features. Quite a few of these features definitely make diff --git a/docs/modules/ROOT/pages/legal.adoc b/docs/modules/ROOT/pages/legal.adoc index 8f0e7f6b32..bcae63734d 100644 --- a/docs/modules/ROOT/pages/legal.adoc +++ b/docs/modules/ROOT/pages/legal.adoc @@ -1,6 +1,7 @@ [legal] [[legal]] = Legal +:page-section-summary-toc: 1 {project-version} diff --git a/docs/modules/ROOT/pages/spring-cloud-contract.adoc b/docs/modules/ROOT/pages/spring-cloud-contract.adoc index b00dfa5963..b2a57fca62 100644 --- a/docs/modules/ROOT/pages/spring-cloud-contract.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-contract.adoc @@ -1,5 +1,6 @@ [[spring-cloud-contract-reference-documentation]] = Spring Cloud Contract Reference Documentation +:page-section-summary-toc: 1 Adam Dudczak, Mathias Düsterhöft, Marcin Grzejszczak, Dennis Kieselhorst, Jakub Kubryński, Karol Lassak, Olga Maciaszek-Sharma, Mariusz Smykuła, Dave Syer, Jay Bryant :docinfo: shared diff --git a/docs/modules/ROOT/pages/yml-schema.adoc b/docs/modules/ROOT/pages/yml-schema.adoc index 739326b846..b5196fc2bb 100644 --- a/docs/modules/ROOT/pages/yml-schema.adoc +++ b/docs/modules/ROOT/pages/yml-schema.adoc @@ -1,5 +1,6 @@ [[yml-schema]] = YML Schema +:page-section-summary-toc: 1 Below you can find a JSON schema definition of a YAML contract.