From 11e940d975eaea5cb83f00a7fb977967df469e57 Mon Sep 17 00:00:00 2001 From: Mark Paluch Date: Thu, 14 Nov 2019 16:00:56 +0100 Subject: [PATCH] Use project-version placeholder in documentation. Closes gh-370. --- README.adoc | 4 ++-- docs/src/main/asciidoc/quickstart.adoc | 2 +- docs/src/main/asciidoc/spring-cloud-vault.adoc | 10 +++++----- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.adoc b/README.adoc index 09b7cc0b..4ea5c9cb 100644 --- a/README.adoc +++ b/README.adoc @@ -161,7 +161,7 @@ the test cases). Example Maven configuration: org.springframework.cloud spring-cloud-starter-vault-config - {spring-cloud-version} + {project-version} org.springframework.boot @@ -565,4 +565,4 @@ Go to `File` -> `Settings` -> `Other settings` -> `Checkstyle`. There click on t - `checkstyle.suppressions.file` - default suppressions. Please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` URL. - `checkstyle.additional.suppressions.file` - this variable corresponds to suppressions in your local project. E.g. you're working on `spring-cloud-contract`. Then point to the `project-root/src/checkstyle/checkstyle-suppressions.xml` folder. Example for `spring-cloud-contract` would be: `/home/username/spring-cloud-contract/src/checkstyle/checkstyle-suppressions.xml`. -IMPORTANT: Remember to set the `Scan Scope` to `All sources` since we apply checkstyle rules for production and test sources. \ No newline at end of file +IMPORTANT: Remember to set the `Scan Scope` to `All sources` since we apply checkstyle rules for production and test sources. diff --git a/docs/src/main/asciidoc/quickstart.adoc b/docs/src/main/asciidoc/quickstart.adoc index 36254d3f..f8af3302 100644 --- a/docs/src/main/asciidoc/quickstart.adoc +++ b/docs/src/main/asciidoc/quickstart.adoc @@ -121,7 +121,7 @@ the test cases). Example Maven configuration: org.springframework.cloud spring-cloud-starter-vault-config - {spring-cloud-version} + {project-version} org.springframework.boot diff --git a/docs/src/main/asciidoc/spring-cloud-vault.adoc b/docs/src/main/asciidoc/spring-cloud-vault.adoc index 72b93d54..05aeeb7e 100644 --- a/docs/src/main/asciidoc/spring-cloud-vault.adoc +++ b/docs/src/main/asciidoc/spring-cloud-vault.adoc @@ -1,7 +1,7 @@ = Spring Cloud Vault :github: https://github.com/spring-cloud/spring-cloud-vault :githubmaster: {github}/tree/master -:revnumber: {spring-cloud-version} +:revnumber: {project-version} :docslink: {githubmaster}/docs/src/main/asciidoc :toc: left :nofooter: @@ -821,7 +821,7 @@ dependency. org.springframework.cloud spring-cloud-vault-config-consul - {spring-cloud-version} + {project-version} ---- @@ -871,7 +871,7 @@ dependency. org.springframework.cloud spring-cloud-vault-config-rabbitmq - {spring-cloud-version} + {project-version} ---- @@ -924,7 +924,7 @@ dependency. org.springframework.cloud spring-cloud-vault-config-aws - {spring-cloud-version} + {project-version} ---- @@ -995,7 +995,7 @@ backend path, e.g. `spring.cloud.vault.mysql.role.backend=database`. org.springframework.cloud spring-cloud-vault-config-databases - {spring-cloud-version} + {project-version} ----