diff --git a/README.adoc b/README.adoc index 5894d9b..0f8f65a 100644 --- a/README.adoc +++ b/README.adoc @@ -13,6 +13,20 @@ confusion with the sub-projects. The names are an alphabetic sequence (so you can sort them chronologically) with names of London Tube stations ("Angel" is the first release, "Brixton" is the second). +== Generating release train documentation + +In order to generate the release train documentation, please update the project with versions for a given release train and then execute the following command: + +```bash +$ ./mvnw clean install -Pdocs,train-docs -pl train-docs +``` + +In order to upload the documentation to the documentation server just execute the following command: + +```bash +$ ./mvnw clean deploy -Pdocs,train-docs -pl train-docs +``` + == Contributing :spring-cloud-build-branch: master diff --git a/docs/src/main/asciidoc/intro.adoc b/docs/src/main/asciidoc/intro.adoc index 5ae66a3..3239161 100644 --- a/docs/src/main/asciidoc/intro.adoc +++ b/docs/src/main/asciidoc/intro.adoc @@ -4,4 +4,18 @@ spring-cloud-dependencies POM to manage dependencies in Maven or Gradle. The release trains have names, not versions, to avoid confusion with the sub-projects. The names are an alphabetic sequence (so you can sort them chronologically) with names of London Tube -stations ("Angel" is the first release, "Brixton" is the second). \ No newline at end of file +stations ("Angel" is the first release, "Brixton" is the second). + +== Generating release train documentation + +In order to generate the release train documentation, please update the project with versions for a given release train and then execute the following command: + +```bash +$ ./mvnw clean install -Pdocs,train-docs -pl train-docs +``` + +In order to upload the documentation to the documentation server just execute the following command: + +```bash +$ ./mvnw clean deploy -Pdocs,train-docs -pl train-docs +``` \ No newline at end of file diff --git a/docs/src/main/asciidoc/spring-cloud-starters.adoc b/docs/src/main/asciidoc/spring-cloud-starters.adoc index 3837023..c9f670b 100644 --- a/docs/src/main/asciidoc/spring-cloud-starters.adoc +++ b/docs/src/main/asciidoc/spring-cloud-starters.adoc @@ -1,9 +1,3 @@ -:github: https://github.com/spring-cloud/spring-cloud-release -:githubmaster: {github}/tree/master -:docslink: {githubmaster}/docs/src/main/asciidoc -:springcloudversion: Hoxton.SR1 -:springBootVersion: 2.1.13.RELEASE - = Spring Cloud Release Train include::intro.adoc[] diff --git a/train-docs/pom.xml b/train-docs/pom.xml index 2036d41..326b3c1 100644 --- a/train-docs/pom.xml +++ b/train-docs/pom.xml @@ -17,8 +17,6 @@ deploy 3.6.3 - - 1.4.1 4.0.6 2.1.0 2.7