From 719453e63ff2b37d5b4f3ff0748bdd99535e222a Mon Sep 17 00:00:00 2001 From: Marcin Grzejszczak Date: Wed, 13 Jul 2016 14:37:09 +0200 Subject: [PATCH] Updated the docs --- README.adoc | 13 +++++++++++++ docs/src/main/asciidoc/building.adoc | 13 +++++++++++++ .../src/site/asciidoc/complex-content.adoc | 2 +- .../src/site/asciidoc/junit.adoc | 4 ++-- .../src/site/asciidoc/spock.adoc | 4 ++-- .../src/site/asciidoc/usage.adoc | 10 +++++----- 6 files changed, 36 insertions(+), 10 deletions(-) diff --git a/README.adoc b/README.adoc index 75e945f3a7..ef4380ace4 100644 --- a/README.adoc +++ b/README.adoc @@ -294,4 +294,17 @@ Build both Maven and Gradle projects and run tests on standalone projects ``` ./scripts/buildAndTest.sh +``` +``` + +Generate documentation + +``` +./scripts/generateDocs.sh +``` + +Publish documentation to `gh-pages` + +``` +./docs/src/main/asciidoc/ghpages.sh ``` \ No newline at end of file diff --git a/docs/src/main/asciidoc/building.adoc b/docs/src/main/asciidoc/building.adoc index 1e05a687b6..157ae36645 100644 --- a/docs/src/main/asciidoc/building.adoc +++ b/docs/src/main/asciidoc/building.adoc @@ -60,3 +60,16 @@ Build both Maven and Gradle projects and run tests on standalone projects ``` ./scripts/buildAndTest.sh ``` +``` + +Generate documentation + +``` +./scripts/generateDocs.sh +``` + +Publish documentation to `gh-pages` + +``` +./docs/src/main/asciidoc/ghpages.sh +``` diff --git a/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/complex-content.adoc b/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/complex-content.adoc index fad117ee37..b3fdeee917 100644 --- a/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/complex-content.adoc +++ b/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/complex-content.adoc @@ -3,7 +3,7 @@ Sample more complex configuration for Java Project with JUnit tests. -=== Project configuration for Accurest with JUnit tests and stub publishing +=== Project configuration for Spring Cloud Contract Verifier with JUnit tests and stub publishing [source,xml] ---- diff --git a/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/junit.adoc b/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/junit.adoc index ad56a34c79..9982638ebb 100644 --- a/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/junit.adoc +++ b/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/junit.adoc @@ -9,7 +9,7 @@ Sample minimal configuration for Java Project with JUnit tests. include::../../../src/test/projects/spring-boot-java/pom.xml[tags=dependencies] ---- -=== Project configuration for Accurest with JUnit tests and stub publishing +=== Project configuration for Spring Cloud Contract Verifier with JUnit tests and stub publishing [source,xml] ---- @@ -26,4 +26,4 @@ include::../../../src/test/projects/spring-boot-java/src/test/java/hello/BaseAcc === Project source code -https://github.com/Codearte/accurest-maven-plugin/tree/master/src/test/projects/spring-boot-java \ No newline at end of file +https://github.com/spring-cloud/spring-cloud-contract/tree/master/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-java \ No newline at end of file diff --git a/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/spock.adoc b/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/spock.adoc index 6e262ede51..7ac9fde9cc 100644 --- a/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/spock.adoc +++ b/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/spock.adoc @@ -9,7 +9,7 @@ Sample minimal configuration for Groovy Project with Spock Specification include::../../../src/test/projects/spring-boot-groovy/pom.xml[tags=dependencies] ---- -=== Project configuration for Accurest, Groovy, Spock specifications and stub publishing +=== Project configuration for Spring Cloud Contract Verifier, Groovy, Spock specifications and stub publishing [source,xml] @@ -26,4 +26,4 @@ include::../../../src/test/projects/spring-boot-groovy/src/test/groovy/hello/Bas === Project source code -https://github.com/Codearte/accurest-maven-plugin/tree/master/src/test/projects/spring-boot-groovy +https://github.com/spring-cloud/spring-cloud-contract/tree/master/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-groovy diff --git a/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/usage.adoc b/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/usage.adoc index 825f738e45..15d1118f98 100644 --- a/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/usage.adoc +++ b/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/usage.adoc @@ -1,16 +1,16 @@ = Usage -== Converting Accurest GroovyDSL into WireMock stub mappings +== Converting Spring Cloud Contract DSL into WireMock stub mappings mvn org.springframework.cloud.contract:spring-cloud-contract-verifier-maven-plugin:convert -or shortly footnoteref:[prefix,Additional configuration inside `~/.m2/settings.xml` is required: `io.codearte.accurest`.] +or shortly footnoteref:[prefix,Additional configuration inside `~/.m2/settings.xml` is required: `io.codearte.Spring Cloud Contract`.] mvn spring-cloud-contract-verifier:convert -For more information please go to the Accurest Wiki or Plugin Documentation Site. +For more information please go to the Spring Cloud Contract Wiki or Plugin Documentation Site. -== Accurest Stub Runner +== Spring Cloud Contract Stub Runner Run stubs mappings from current directory: @@ -24,7 +24,7 @@ or shortly footnoteref:[prefix] mvn spring-cloud-contract-verifier:run -Dstubs="org.springframework:gs-rest-service" -where `org.springframework:gs-rest-service` is artifact with stubs classifier contains wiremock mappings. +where `org.springframework:gs-rest-service` is artifact with stubs classifier contains WireMock mappings. == Project configuration