From 4ccec4fd22bfc6645292638d76c915f1b9a0ecf4 Mon Sep 17 00:00:00 2001 From: Marcin Grzejszczak Date: Fri, 15 Jul 2016 11:59:26 +0200 Subject: [PATCH] Refactored the documentation --- README.adoc | 13 +++++++++++-- docs/src/main/asciidoc/README.adoc | 13 ++++++++++--- docs/src/main/asciidoc/building.adoc | 1 - .../main/asciidoc/spring-cloud-contract.adoc | 18 +++++++++--------- .../main/asciidoc/spring-cloud-wiremock.adoc | 4 ++++ .../main/asciidoc/{ => verifier}/contract.adoc | 2 +- .../asciidoc/{ => verifier}/introduction.adoc | 0 .../main/asciidoc/{ => verifier}/links.adoc | 0 .../asciidoc/{ => verifier}/messaging.adoc | 2 +- .../src/main/asciidoc/{ => verifier}/rest.adoc | 4 ++-- .../asciidoc/{ => verifier}/stubrunner.adoc | 2 +- .../{ => verifier}/stubrunner_msg.adoc | 2 +- 12 files changed, 40 insertions(+), 21 deletions(-) create mode 100644 docs/src/main/asciidoc/spring-cloud-wiremock.adoc rename docs/src/main/asciidoc/{ => verifier}/contract.adoc (99%) rename docs/src/main/asciidoc/{ => verifier}/introduction.adoc (100%) rename docs/src/main/asciidoc/{ => verifier}/links.adoc (100%) rename docs/src/main/asciidoc/{ => verifier}/messaging.adoc (99%) rename docs/src/main/asciidoc/{ => verifier}/rest.adoc (98%) rename docs/src/main/asciidoc/{ => verifier}/stubrunner.adoc (99%) rename docs/src/main/asciidoc/{ => verifier}/stubrunner_msg.adoc (98%) diff --git a/README.adoc b/README.adoc index fe1b5413a1..778831560d 100644 --- a/README.adoc +++ b/README.adoc @@ -12,7 +12,17 @@ image:https://circleci.com/gh/spring-cloud/spring-cloud-contract.svg?style=svg[" = Spring Cloud Contract -What you always need it confidence in pushing new features into a new application or service in a distributed system. This project provides support for Consumer Driven Contracts and service schemas in Spring applications, covering a range of options for writing tests, publishing them as assets, asserting that a contract is kept by producers and consumers, for HTTP and message-based interactions. +What you always need it confidence in pushing new features into a new application or service in a distributed system. +This project provides support for Consumer Driven Contracts and service schemas in Spring applications, covering a +range of options for writing tests, publishing them as assets, asserting that a contract is kept by producers +and consumers, for HTTP and message-based interactions. + +== Spring Cloud Contract WireMock + +Modules giving you the possibility to use http://wiremock.org[WireMock] with different servers. Check out the +https://github.com/spring-cloud/spring-cloud-contract/tree/master/samples[samples] for more information. + +Currently we support Jetty, Native WireMock server, Tomcat and Undertow. == Spring Cloud Contract Verifier @@ -295,7 +305,6 @@ Build both Maven and Gradle projects and run tests on standalone projects ``` ./scripts/buildAndTest.sh ``` -``` Generate documentation diff --git a/docs/src/main/asciidoc/README.adoc b/docs/src/main/asciidoc/README.adoc index 1225de1063..f92e9d129d 100644 --- a/docs/src/main/asciidoc/README.adoc +++ b/docs/src/main/asciidoc/README.adoc @@ -10,13 +10,20 @@ image:https://circleci.com/gh/spring-cloud/spring-cloud-contract.svg?style=svg[" = Spring Cloud Contract -What you always need it confidence in pushing new features into a new application or service in a distributed system. This project provides support for Consumer Driven Contracts and service schemas in Spring applications, covering a range of options for writing tests, publishing them as assets, asserting that a contract is kept by producers and consumers, for HTTP and message-based interactions. +What you always need it confidence in pushing new features into a new application or service in a distributed system. +This project provides support for Consumer Driven Contracts and service schemas in Spring applications, covering a +range of options for writing tests, publishing them as assets, asserting that a contract is kept by producers +and consumers, for HTTP and message-based interactions. + +== Spring Cloud Contract WireMock + +include::spring-cloud-wiremock.adoc[] == Spring Cloud Contract Verifier -include::introduction.adoc[] +include::verifier/introduction.adoc[] -include::links.adoc[] +include::verifier/links.adoc[] == Documentation diff --git a/docs/src/main/asciidoc/building.adoc b/docs/src/main/asciidoc/building.adoc index ab039d35aa..0589bcdee7 100644 --- a/docs/src/main/asciidoc/building.adoc +++ b/docs/src/main/asciidoc/building.adoc @@ -60,7 +60,6 @@ Build both Maven and Gradle projects and run tests on standalone projects ``` ./scripts/buildAndTest.sh ``` -``` Generate documentation diff --git a/docs/src/main/asciidoc/spring-cloud-contract.adoc b/docs/src/main/asciidoc/spring-cloud-contract.adoc index fbff95b563..0bc2e8f036 100644 --- a/docs/src/main/asciidoc/spring-cloud-contract.adoc +++ b/docs/src/main/asciidoc/spring-cloud-contract.adoc @@ -1,23 +1,23 @@ -:core_path: ../../../.. +:core_path: ../../../../.. :verifier_root_path: {core_path}/spring-cloud-contract-verifier :verifier_core_path: {verifier_root_path}/spring-cloud-contract-verifier-core :stubrunner_core_path: {core_path}/spring-cloud-contract-stub-runner :toc: left -= Spring Cloud Contract Verifier += Spring Cloud Contract _Documentation Authors: Adam Dudczak, Marcin Grzejszczak, Jakub Kubryński, Karol Lassak, Olga Maciaszek-Sharma, Mariusz Smykuła_ -include::introduction.adoc[] +include::verifier/introduction.adoc[] -include::contract.adoc[] +include::verifier/contract.adoc[] -include::rest.adoc[] +include::verifier/rest.adoc[] -include::messaging.adoc[] +include::verifier/messaging.adoc[] -include::stubrunner.adoc[] +include::verifier/stubrunner.adoc[] -include::stubrunner_msg.adoc[] +include::verifier/stubrunner_msg.adoc[] -include::links.adoc[] \ No newline at end of file +include::verifier/links.adoc[] \ No newline at end of file diff --git a/docs/src/main/asciidoc/spring-cloud-wiremock.adoc b/docs/src/main/asciidoc/spring-cloud-wiremock.adoc new file mode 100644 index 0000000000..7287c0b742 --- /dev/null +++ b/docs/src/main/asciidoc/spring-cloud-wiremock.adoc @@ -0,0 +1,4 @@ +Modules giving you the possibility to use http://wiremock.org[WireMock] with different servers. Check out the +https://github.com/spring-cloud/spring-cloud-contract/tree/master/samples[samples] for more information. + +Currently we support Jetty, Native WireMock server, Tomcat and Undertow. \ No newline at end of file diff --git a/docs/src/main/asciidoc/contract.adoc b/docs/src/main/asciidoc/verifier/contract.adoc similarity index 99% rename from docs/src/main/asciidoc/contract.adoc rename to docs/src/main/asciidoc/verifier/contract.adoc index 8692f92b62..1e7077cf9f 100644 --- a/docs/src/main/asciidoc/contract.adoc +++ b/docs/src/main/asciidoc/verifier/contract.adoc @@ -1,4 +1,4 @@ -:core_path: ../../../.. +:core_path: ../../../../.. :verifier_root_path: {core_path}/spring-cloud-contract-verifier :verifier_core_path: {verifier_root_path}/spring-cloud-contract-verifier-core diff --git a/docs/src/main/asciidoc/introduction.adoc b/docs/src/main/asciidoc/verifier/introduction.adoc similarity index 100% rename from docs/src/main/asciidoc/introduction.adoc rename to docs/src/main/asciidoc/verifier/introduction.adoc diff --git a/docs/src/main/asciidoc/links.adoc b/docs/src/main/asciidoc/verifier/links.adoc similarity index 100% rename from docs/src/main/asciidoc/links.adoc rename to docs/src/main/asciidoc/verifier/links.adoc diff --git a/docs/src/main/asciidoc/messaging.adoc b/docs/src/main/asciidoc/verifier/messaging.adoc similarity index 99% rename from docs/src/main/asciidoc/messaging.adoc rename to docs/src/main/asciidoc/verifier/messaging.adoc index 9dab38ac97..7a4d0f85c4 100644 --- a/docs/src/main/asciidoc/messaging.adoc +++ b/docs/src/main/asciidoc/verifier/messaging.adoc @@ -1,4 +1,4 @@ -:core_path: ../../../.. +:core_path: ../../../../.. :verifier_root_path: {core_path}/spring-cloud-contract-verifier :verifier_core_path: {verifier_root_path}/spring-cloud-contract-verifier-core diff --git a/docs/src/main/asciidoc/rest.adoc b/docs/src/main/asciidoc/verifier/rest.adoc similarity index 98% rename from docs/src/main/asciidoc/rest.adoc rename to docs/src/main/asciidoc/verifier/rest.adoc index 4ba664174b..6e0ace6dcf 100644 --- a/docs/src/main/asciidoc/rest.adoc +++ b/docs/src/main/asciidoc/verifier/rest.adoc @@ -1,4 +1,4 @@ -:core_path: ../../../.. +:core_path: ../../../../.. :verifier_root_path: {core_path}/spring-cloud-contract-verifier :verifier_core_path: {verifier_root_path}/spring-cloud-contract-verifier-core @@ -432,6 +432,6 @@ Such tree will cause Spring Cloud Contract Verifier generating Wiremock's scenar - login marked as `Started` pointing to: - showCart marked as `Step1` pointing to: - logout marked as `Step2` which will close the scenario. -More details about Wiremock scenarios can be found under [http://wiremock.org/stateful-behaviour.html](http://wiremock.org/stateful-behaviour.html) +More details about Wiremock scenarios can be found under http://wiremock.org/stateful-behaviour.html[http://wiremock.org/stateful-behaviour.html] Spring Cloud Contract Verifier will also generate tests with guaranteed order of execution. diff --git a/docs/src/main/asciidoc/stubrunner.adoc b/docs/src/main/asciidoc/verifier/stubrunner.adoc similarity index 99% rename from docs/src/main/asciidoc/stubrunner.adoc rename to docs/src/main/asciidoc/verifier/stubrunner.adoc index 8c18a39d06..d76bfa18d5 100644 --- a/docs/src/main/asciidoc/stubrunner.adoc +++ b/docs/src/main/asciidoc/verifier/stubrunner.adoc @@ -1,4 +1,4 @@ -:core_path: ../../../.. +:core_path: ../../../../.. :verifier_root_path: {core_path}/spring-cloud-contract-verifier :verifier_core_path: {verifier_root_path}/spring-cloud-contract-verifier-core diff --git a/docs/src/main/asciidoc/stubrunner_msg.adoc b/docs/src/main/asciidoc/verifier/stubrunner_msg.adoc similarity index 98% rename from docs/src/main/asciidoc/stubrunner_msg.adoc rename to docs/src/main/asciidoc/verifier/stubrunner_msg.adoc index 194076d611..088c3a17ed 100644 --- a/docs/src/main/asciidoc/stubrunner_msg.adoc +++ b/docs/src/main/asciidoc/verifier/stubrunner_msg.adoc @@ -1,4 +1,4 @@ -:core_path: ../../../.. +:core_path: ../../../../.. :verifier_root_path: {core_path}/spring-cloud-contract-verifier :verifier_core_path: {verifier_root_path}/spring-cloud-contract-verifier-core :stubrunner_core_path: {core_path}/spring-cloud-contract-stub-runner