diff --git a/docs/src/main/asciidoc/_attributes.adoc b/docs/src/main/asciidoc/_attributes.adoc index 247c730453..39e2411504 100644 --- a/docs/src/main/asciidoc/_attributes.adoc +++ b/docs/src/main/asciidoc/_attributes.adoc @@ -15,8 +15,8 @@ :project-full-name: Spring Cloud Contract // project-specific attributes -:core_path: ../../.. -:plugins_path: ../../../spring-cloud-contract-tools +:core_path: {github-raw} +:plugins_path: {github-raw}/spring-cloud-contract-tools :converters_path: {plugins_path}/spring-cloud-contract-converters :verifier_root_path: {core_path}/spring-cloud-contract-verifier :contract_spec_path: {core_path}/specs/spring-cloud-contract-spec-java @@ -31,4 +31,5 @@ :tests_path: {core_path}/tests :samples_branch: 2.2.x :samples_url: https://raw.githubusercontent.com/spring-cloud-samples/spring-cloud-contract-samples/{samples_branch} -:introduction_url: {core_path}/.. \ No newline at end of file + +:introduction_url: {core_path} \ No newline at end of file diff --git a/docs/src/main/asciidoc/getting-started.adoc b/docs/src/main/asciidoc/getting-started.adoc index 9efbbb505f..df57caf502 100644 --- a/docs/src/main/asciidoc/getting-started.adoc +++ b/docs/src/main/asciidoc/getting-started.adoc @@ -231,7 +231,7 @@ Stub Runner` properties, as shown in the following example: + [source,yaml,indent=0] ---- -include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-contract/{branch}/samples/standalone/dsl/http-client/src/test/resources/application-test-repo.yaml[] +include::{introduction_url}/samples/standalone/dsl/http-client/src/test/resources/application-test-repo.yaml[] ---- Now you can annotate your test class with `@AutoConfigureStubRunner`. In the annotation, @@ -539,7 +539,7 @@ Runner` properties, as shown in the following example: + [source,yaml,indent=0] ---- -include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-contract/{branch}/samples/standalone/dsl/http-client/src/test/resources/application-test-repo.yaml[] +include::{introduction_url}/samples/standalone/dsl/http-client/src/test/resources/application-test-repo.yaml[] ---- Now you can annotate your test class with `@AutoConfigureStubRunner`. In the annotation, @@ -1041,8 +1041,8 @@ As a developer of the Loan Issuance service (a consumer of the Fraud Detection s "Loan\nIssuance"->"Loan\nIssuance": merge the\nfeature branch\nto master branch "Loan\nIssuance"->"Loan\nIssuance": setup SCC Stub Runner\nto fetch stubs\nfrom Nexus / Artifactory "Loan\nIssuance"->"LI\nSCC\nStub Runner": start stubs\nof FD from\nNexus / Artifactory -"LI\nSCC\nStub Runner"->"Local storage": find stubs of [FD] -"Local storage"->"LI\nSCC\nStub Runner": stubs of [FD] found +"LI\nSCC\nStub Runner"->"Nexus / Artifactory": find stubs of [FD] +"Nexus / Artifactory"->"LI\nSCC\nStub Runner": stubs of [FD] found "LI\nSCC\nStub Runner"->"FD stub": run stubs of [FD] "FD stub"->"LI\nSCC\nStub Runner": [FD] stub is running "LI\nSCC\nStub Runner"->"Loan\nIssuance": stubs running and ready for the test @@ -1050,10 +1050,8 @@ As a developer of the Loan Issuance service (a consumer of the Fraud Detection s "Loan\nIssuance"->"FD stub": the test\nsends a request\nto the running stub "FD stub"->"Loan\nIssuance": stub responds successfuly "Loan\nIssuance"->"Loan\nIssuance": the test passes successfully -"Loan\nIssuance"->"Fraud\nDetection": send a pull request\nwith the\nsuggested contracts ---- - *Merge branch to master.* [source,bash,indent=0] @@ -1072,7 +1070,7 @@ achieving the same thing by changing the properties. [source,yaml,indent=0] ---- -include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-contract/{branch}/samples/standalone/dsl/http-client/src/test/resources/application-test-repo.yaml[] +include::{introduction_url}/samples/standalone/dsl/http-client/src/test/resources/application-test-repo.yaml[] ---- That's it! @@ -1086,23 +1084,24 @@ https://spring.io/guides/[getting started] guides that solve specific "`How do I with Spring?`" problems. We also have {project-full-name}-specific "`<>`" reference documentation. -Otherwise, the next logical step is to read _<>_. If +Otherwise, the next logical step is to read _<>_. If you are really impatient, you could also jump ahead and read about _<>_. -// TODO: Update the video // TODO: Check if we can link courses -In addition to that you can check out the video from the Warsaw JUG about Spring Cloud Contract: +In addition to that you can check out the following videos: -video::sAAklvxmPmk[youtube,start=538,width=640,height=480] +- "Consumer Driven Contracts and Your Microservice Architecture" by Olga Maciaszek-Sharma and Marcin Grzejszczak -You can read the following articles / presentations: +video::pDkC_00hhvA[youtube,width=640,height=480] -// TODO: Update the readings -- https://www.slideshare.net/MarcinGrzejszczak/stick-to-the-rules-consumer-driven-contracts-201507-confitura[Slides from Marcin Grzejszczak's talk about Accurest] -- https://toomuchcoding.com/blog/categories/accurest/[Accurest related articles from Marcin Grzejszczak's blog] -- https://toomuchcoding.com/blog/categories/spring-cloud-contract/[Spring Cloud Contract related articles from Marcin Grzejszczak's blog] -- https://groovy-lang.org/json.html[Groovy docs regarding JSON] +- "Contract Tests in the Enterprise" by Marcin Grzejszczak + +video::ZyHG-VOzPZg[youtube,width=640,height=480] + +- "Why Contract Tests Matter?" by Marcin Grzejszczak + +video::TvpkZu1e2Dc[youtube,start=6262,width=640,height=480] You can find the default project samples at https://github.com/spring-cloud-samples/spring-cloud-contract-samples[samples]. \ No newline at end of file