Refactored the documentation

This commit is contained in:
Marcin Grzejszczak
2016-07-15 11:59:26 +02:00
parent 15dc75dece
commit 4ccec4fd22
12 changed files with 40 additions and 21 deletions

View File

@@ -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

View File

@@ -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

View File

@@ -60,7 +60,6 @@ Build both Maven and Gradle projects and run tests on standalone projects
```
./scripts/buildAndTest.sh
```
```
Generate documentation

View File

@@ -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[]
include::verifier/links.adoc[]

View File

@@ -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.

View File

@@ -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

View File

@@ -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

View File

@@ -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.

View File

@@ -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

View File

@@ -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