Updated docs

This commit is contained in:
Marcin Grzejszczak
2020-06-09 16:45:33 +02:00
parent 6e658725f6
commit 07ff7a5726
4 changed files with 29 additions and 9 deletions

View File

@@ -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

View File

@@ -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).
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
```

View File

@@ -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[]

View File

@@ -17,8 +17,6 @@
<upload-docs-zip.phase>deploy</upload-docs-zip.phase>
<maven.version>3.6.3</maven.version>
<!-- Resolver has to be aligned with Maven (e.g resolver 1.4 and Maven 3.6 or resolver 1.3 and Maven 3.5) -->
<maven.resolver.version>1.4.1</maven.resolver.version>
<handlebars.version>4.0.6</handlebars.version>
<asciidoctorj.version>2.1.0</asciidoctorj.version>
<commons-io.version>2.7</commons-io.version>