From 3fe830bd92a5b07422399c19c6279fd2ead7df2e Mon Sep 17 00:00:00 2001 From: spencergibb Date: Wed, 20 Sep 2023 15:58:45 -0400 Subject: [PATCH] Uses 4.0.x branch for docs --- README.adoc | 10 +++++----- docs/src/main/asciidoc/README.adoc | 4 ++-- docs/src/main/asciidoc/quickstart.adoc | 6 +++--- docs/src/main/asciidoc/spring-cloud-vault.adoc | 4 ++-- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.adoc b/README.adoc index 813174ac..d2051d09 100644 --- a/README.adoc +++ b/README.adoc @@ -59,7 +59,7 @@ $ wget https://releases.hashicorp.com/vault/${vault_version}/vault_${vault_versi $ unzip vault_${vault_version}_${platform}.zip ---- -NOTE: These steps can be achieved by downloading and running https://github.com/spring-cloud/spring-cloud-vault/blob/master/src/test/bash/install_vault.sh[`install_vault.sh`]. +NOTE: These steps can be achieved by downloading and running https://github.com/spring-cloud/spring-cloud-vault/blob/4.0.x/src/test/bash/install_vault.sh[`install_vault.sh`]. *Create SSL certificates for Vault* @@ -72,7 +72,7 @@ Make sure to import the Root Certificate into a Java-compliant truststore. The easiest way to achieve this is by using OpenSSL. -NOTE: https://github.com/spring-cloud/spring-cloud-vault/blob/master/src/test/bash/[`create_certificates.sh`] creates certificates in `work/ca` and a JKS truststore `work/keystore.jks`. +NOTE: https://github.com/spring-cloud/spring-cloud-vault/blob/4.0.x/src/test/bash/[`create_certificates.sh`] creates certificates in `work/ca` and a JKS truststore `work/keystore.jks`. If you want to run Spring Cloud Vault using this quickstart guide you need to configure the truststore the `spring.cloud.vault.ssl.trust-store` property to `file:work/keystore.jks`. [[quickstart.vault.start]] @@ -94,7 +94,7 @@ listener "tcp" { disable_mlock = true ---- -NOTE: You can find an example config file at https://github.com/spring-clod/spring-cloud-vault/blob/master/src/test/bash/vault.conf[`vault.conf`]. +NOTE: You can find an example config file at https://github.com/spring-clod/spring-cloud-vault/blob/4.0.x/src/test/bash/vault.conf[`vault.conf`]. [source,bash] ---- @@ -426,7 +426,7 @@ author credit if we do. Active contributors might be asked to join the core tea given the ability to merge pull requests. === Code of Conduct -This project adheres to the Contributor Covenant https://github.com/spring-cloud/spring-cloud-build/blob/master/docs/src/main/asciidoc/code-of-conduct.adoc[code of +This project adheres to the Contributor Covenant https://github.com/spring-cloud/spring-cloud-build/blob/{spring-cloud-build-branch}/docs/src/main/asciidoc/code-of-conduct.adoc[code of conduct]. By participating, you are expected to uphold this code. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io. @@ -437,7 +437,7 @@ added after the original pull request but before a merge. * Use the Spring Framework code format conventions. If you use Eclipse you can import formatter settings using the `eclipse-code-formatter.xml` file from the - https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-dependencies-parent/eclipse-code-formatter.xml[Spring + https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/{spring-cloud-build-branch}/spring-cloud-dependencies-parent/eclipse-code-formatter.xml[Spring Cloud Build] project. If using IntelliJ, you can use the https://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter Plugin] to import the same file. diff --git a/docs/src/main/asciidoc/README.adoc b/docs/src/main/asciidoc/README.adoc index 4f74e3d2..adef687d 100644 --- a/docs/src/main/asciidoc/README.adoc +++ b/docs/src/main/asciidoc/README.adoc @@ -62,8 +62,8 @@ $ ./docs/src/main/ruby/generate_readme.sh > README.adoc This script requires ruby and the asciidoctor gem installed (`gem install asciidoctor`) -include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/building.adoc[] +include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/4.0.x/docs/src/main/asciidoc/building.adoc[] == Contributing -include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing.adoc[] +include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/4.0.x/docs/src/main/asciidoc/contributing.adoc[] diff --git a/docs/src/main/asciidoc/quickstart.adoc b/docs/src/main/asciidoc/quickstart.adoc index 755be787..7cc324a7 100644 --- a/docs/src/main/asciidoc/quickstart.adoc +++ b/docs/src/main/asciidoc/quickstart.adoc @@ -18,7 +18,7 @@ $ wget https://releases.hashicorp.com/vault/${vault_version}/vault_${vault_versi $ unzip vault_${vault_version}_${platform}.zip ---- -NOTE: These steps can be achieved by downloading and running https://github.com/spring-cloud/spring-cloud-vault/blob/master/src/test/bash/install_vault.sh[`install_vault.sh`]. +NOTE: These steps can be achieved by downloading and running https://github.com/spring-cloud/spring-cloud-vault/blob/4.0.x/src/test/bash/install_vault.sh[`install_vault.sh`]. *Create SSL certificates for Vault* @@ -31,7 +31,7 @@ Make sure to import the Root Certificate into a Java-compliant truststore. The easiest way to achieve this is by using OpenSSL. -NOTE: https://github.com/spring-cloud/spring-cloud-vault/blob/master/src/test/bash/[`create_certificates.sh`] creates certificates in `work/ca` and a JKS truststore `work/keystore.jks`. +NOTE: https://github.com/spring-cloud/spring-cloud-vault/blob/4.0.x/src/test/bash/[`create_certificates.sh`] creates certificates in `work/ca` and a JKS truststore `work/keystore.jks`. If you want to run Spring Cloud Vault using this quickstart guide you need to configure the truststore the `spring.cloud.vault.ssl.trust-store` property to `file:work/keystore.jks`. [[quickstart.vault.start]] @@ -53,7 +53,7 @@ listener "tcp" { disable_mlock = true ---- -NOTE: You can find an example config file at https://github.com/spring-clod/spring-cloud-vault/blob/master/src/test/bash/vault.conf[`vault.conf`]. +NOTE: You can find an example config file at https://github.com/spring-clod/spring-cloud-vault/blob/4.0.x/src/test/bash/vault.conf[`vault.conf`]. [source,bash] ---- diff --git a/docs/src/main/asciidoc/spring-cloud-vault.adoc b/docs/src/main/asciidoc/spring-cloud-vault.adoc index 42cb1093..ff0e1374 100644 --- a/docs/src/main/asciidoc/spring-cloud-vault.adoc +++ b/docs/src/main/asciidoc/spring-cloud-vault.adoc @@ -1,8 +1,8 @@ = Spring Cloud Vault :github: https://github.com/spring-cloud/spring-cloud-vault -:githubmaster: {github}/tree/master +:githubbranch: {github}/tree/4.0.x :revnumber: {project-version} -:docslink: {githubmaster}/docs/src/main/asciidoc +:docslink: {githubbranch}/docs/src/main/asciidoc :toc: left :nofooter: