From 0720c2aa03cdca67792c0361dd0371cf570abe32 Mon Sep 17 00:00:00 2001 From: Marcin Grzejszczak Date: Tue, 19 Jul 2016 19:54:27 +0200 Subject: [PATCH] Updated docs --- README.adoc | 6 +++--- docs/src/main/asciidoc/spring-cloud-contract.adoc | 4 +++- docs/src/main/asciidoc/verifier/introduction.adoc | 6 +++--- 3 files changed, 9 insertions(+), 7 deletions(-) diff --git a/README.adoc b/README.adoc index fd2bbeed2f..3dbf6700df 100644 --- a/README.adoc +++ b/README.adoc @@ -139,7 +139,7 @@ going through the process. CDC is all about communication. The https://github.com/spring-cloud/spring-cloud-contract/tree/master/samples/samples/http-server[server side code is available here] and https://github.com/spring-cloud/spring-cloud-contract/tree/master/samples/samples/http-client[the client side code here]. -=== Consumer side (Loan Issuance) +===== Consumer side (Loan Issuance) As a developer of the Loan Issuance service (a consumer of the Fraud Detection server): @@ -396,7 +396,7 @@ What we did until now is an iterative process. We can play around with the contr Once we're satisfied with the results and the test passes publish a PR to the server side. Currently the consumer side work is done. -=== Producer side (Fraud Detection server) +===== Producer side (Fraud Detection server) As a developer of the Fraud Detection server (a server to the Loan Issuance service): @@ -557,7 +557,7 @@ git push origin master Then we assume that your CI would run sth like `./mvnw clean deploy` which would publish both the application and the stub artifcats. -=== Consumer side (Loan Issuance) final step +===== Consumer side (Loan Issuance) final step As a developer of the Loan Issuance service (a consumer of the Fraud Detection server): diff --git a/docs/src/main/asciidoc/spring-cloud-contract.adoc b/docs/src/main/asciidoc/spring-cloud-contract.adoc index c84655995f..ca818f66cd 100644 --- a/docs/src/main/asciidoc/spring-cloud-contract.adoc +++ b/docs/src/main/asciidoc/spring-cloud-contract.adoc @@ -1,11 +1,13 @@ :toc: left -:toclevels: 4 +:toclevels: 6 = Spring Cloud Contract _Documentation Authors: Adam Dudczak, Marcin Grzejszczak, Jakub Kubryński, Karol Lassak, Olga Maciaszek-Sharma, Mariusz Smykuła, Dave Syer_ +== 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 diff --git a/docs/src/main/asciidoc/verifier/introduction.adoc b/docs/src/main/asciidoc/verifier/introduction.adoc index 6235e752c8..38ecf46782 100644 --- a/docs/src/main/asciidoc/verifier/introduction.adoc +++ b/docs/src/main/asciidoc/verifier/introduction.adoc @@ -117,7 +117,7 @@ going through the process. CDC is all about communication. The https://github.com/spring-cloud/spring-cloud-contract/tree/master/samples/samples/http-server[server side code is available here] and https://github.com/spring-cloud/spring-cloud-contract/tree/master/samples/samples/http-client[the client side code here]. -=== Consumer side (Loan Issuance) +===== Consumer side (Loan Issuance) As a developer of the Loan Issuance service (a consumer of the Fraud Detection server): @@ -285,7 +285,7 @@ What we did until now is an iterative process. We can play around with the contr Once we're satisfied with the results and the test passes publish a PR to the server side. Currently the consumer side work is done. -=== Producer side (Fraud Detection server) +===== Producer side (Fraud Detection server) As a developer of the Fraud Detection server (a server to the Loan Issuance service): @@ -395,7 +395,7 @@ git push origin master Then we assume that your CI would run sth like `./mvnw clean deploy` which would publish both the application and the stub artifcats. -=== Consumer side (Loan Issuance) final step +===== Consumer side (Loan Issuance) final step As a developer of the Loan Issuance service (a consumer of the Fraud Detection server):