From 3fa8fb8c1f04d5ab64d1c750a6bc48aa7889a746 Mon Sep 17 00:00:00 2001 From: buildmaster Date: Fri, 6 Sep 2019 11:16:42 +0000 Subject: [PATCH] Sync docs from master to gh-pages --- reference/html/README.html | 27 ++++++++++++++++++++------ reference/html/index.html | 27 ++++++++++++++++++++------ reference/html/spring-cloud-build.html | 27 ++++++++++++++++++++------ 3 files changed, 63 insertions(+), 18 deletions(-) diff --git a/reference/html/README.html b/reference/html/README.html index 9b21d50e..51e32742 100644 --- a/reference/html/README.html +++ b/reference/html/README.html @@ -504,13 +504,17 @@ approach of generating documentation just add these plugins to your docs(3) </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>exec-maven-plugin</artifactId> (4) + </plugin> <plugin> <groupId>org.asciidoctor</groupId> - <artifactId>asciidoctor-maven-plugin</artifactId> (4) + <artifactId>asciidoctor-maven-plugin</artifactId> (5) </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-antrun-plugin</artifactId> (5) + <artifactId>maven-antrun-plugin</artifactId> (6) </plugin> </plugins> </build> @@ -534,10 +538,14 @@ approach of generating documentation just add these plugins to your docs 4 -This plugin is required to parse the Asciidoctor documentation +This plugin generates an adoc file with all the configuration properties from the classpath 5 +This plugin is required to parse the Asciidoctor documentation + + +6 This plugin is required to copy resources into proper final destinations and to generate main README.adoc and to assert that no files use unresolved links @@ -555,6 +563,9 @@ The order of plugin declaration is important!
+

In order for the build to generate the adoc file with all your configuration properties, your docs module should contain all the dependencies on the classpath, that you would want to scan for configuration properties. The file will be output to ${docsModule}/src/main/asciidoc/configprops.adoc file.

+
+

Spring Cloud Build Docs comes with a set of attributes for asciidoctor that you can reuse.

@@ -574,11 +585,15 @@ The order of plugin declaration is important! <project-root>${maven.multiModuleProjectDirectory}</project-root> <!-- It's mandatory for you to pass the docs.main property --> <github-repo>${docs.main}</github-repo> - <github-raw>https://raw.githubusercontent.com/spring-cloud/${docs.main}/${github-tag}</github-raw> - <github-code>https://github.com/spring-cloud/${docs.main}/tree/${github-tag}</github-code> + <github-raw> + https://raw.githubusercontent.com/spring-cloud/${docs.main}/${github-tag} + </github-raw> + <github-code>https://github.com/spring-cloud/${docs.main}/tree/${github-tag} + </github-code> <github-issues>https://github.com/spring-cloud/${docs.main}/issues/</github-issues> <github-wiki>https://github.com/spring-cloud/${docs.main}/wiki</github-wiki> - <github-master-code>https://github.com/spring-cloud/${docs.main}/tree/master</github-master-code> + <github-master-code>https://github.com/spring-cloud/${docs.main}/tree/master + </github-master-code> <index-link>${index-link}</index-link> <!-- Spring Cloud specific --> diff --git a/reference/html/index.html b/reference/html/index.html index f8852d42..741c2ad1 100644 --- a/reference/html/index.html +++ b/reference/html/index.html @@ -505,13 +505,17 @@ approach of generating documentation just add these plugins to your docs(3) </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>exec-maven-plugin</artifactId> (4) + </plugin> <plugin> <groupId>org.asciidoctor</groupId> - <artifactId>asciidoctor-maven-plugin</artifactId> (4) + <artifactId>asciidoctor-maven-plugin</artifactId> (5) </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-antrun-plugin</artifactId> (5) + <artifactId>maven-antrun-plugin</artifactId> (6) </plugin> </plugins> </build> @@ -535,10 +539,14 @@ approach of generating documentation just add these plugins to your docs 4 -This plugin is required to parse the Asciidoctor documentation +This plugin generates an adoc file with all the configuration properties from the classpath 5 +This plugin is required to parse the Asciidoctor documentation + + +6 This plugin is required to copy resources into proper final destinations and to generate main README.adoc and to assert that no files use unresolved links @@ -556,6 +564,9 @@ The order of plugin declaration is important!
+

In order for the build to generate the adoc file with all your configuration properties, your docs module should contain all the dependencies on the classpath, that you would want to scan for configuration properties. The file will be output to ${docsModule}/src/main/asciidoc/configprops.adoc file.

+
+

Spring Cloud Build Docs comes with a set of attributes for asciidoctor that you can reuse.

@@ -575,11 +586,15 @@ The order of plugin declaration is important! <project-root>${maven.multiModuleProjectDirectory}</project-root> <!-- It's mandatory for you to pass the docs.main property --> <github-repo>${docs.main}</github-repo> - <github-raw>https://raw.githubusercontent.com/spring-cloud/${docs.main}/${github-tag}</github-raw> - <github-code>https://github.com/spring-cloud/${docs.main}/tree/${github-tag}</github-code> + <github-raw> + https://raw.githubusercontent.com/spring-cloud/${docs.main}/${github-tag} + </github-raw> + <github-code>https://github.com/spring-cloud/${docs.main}/tree/${github-tag} + </github-code> <github-issues>https://github.com/spring-cloud/${docs.main}/issues/</github-issues> <github-wiki>https://github.com/spring-cloud/${docs.main}/wiki</github-wiki> - <github-master-code>https://github.com/spring-cloud/${docs.main}/tree/master</github-master-code> + <github-master-code>https://github.com/spring-cloud/${docs.main}/tree/master + </github-master-code> <index-link>${index-link}</index-link> <!-- Spring Cloud specific --> diff --git a/reference/html/spring-cloud-build.html b/reference/html/spring-cloud-build.html index f8852d42..741c2ad1 100644 --- a/reference/html/spring-cloud-build.html +++ b/reference/html/spring-cloud-build.html @@ -505,13 +505,17 @@ approach of generating documentation just add these plugins to your docs(3) </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>exec-maven-plugin</artifactId> (4) + </plugin> <plugin> <groupId>org.asciidoctor</groupId> - <artifactId>asciidoctor-maven-plugin</artifactId> (4) + <artifactId>asciidoctor-maven-plugin</artifactId> (5) </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-antrun-plugin</artifactId> (5) + <artifactId>maven-antrun-plugin</artifactId> (6) </plugin> </plugins> </build> @@ -535,10 +539,14 @@ approach of generating documentation just add these plugins to your docs 4 -This plugin is required to parse the Asciidoctor documentation +This plugin generates an adoc file with all the configuration properties from the classpath 5 +This plugin is required to parse the Asciidoctor documentation + + +6 This plugin is required to copy resources into proper final destinations and to generate main README.adoc and to assert that no files use unresolved links @@ -556,6 +564,9 @@ The order of plugin declaration is important!
+

In order for the build to generate the adoc file with all your configuration properties, your docs module should contain all the dependencies on the classpath, that you would want to scan for configuration properties. The file will be output to ${docsModule}/src/main/asciidoc/configprops.adoc file.

+
+

Spring Cloud Build Docs comes with a set of attributes for asciidoctor that you can reuse.

@@ -575,11 +586,15 @@ The order of plugin declaration is important! <project-root>${maven.multiModuleProjectDirectory}</project-root> <!-- It's mandatory for you to pass the docs.main property --> <github-repo>${docs.main}</github-repo> - <github-raw>https://raw.githubusercontent.com/spring-cloud/${docs.main}/${github-tag}</github-raw> - <github-code>https://github.com/spring-cloud/${docs.main}/tree/${github-tag}</github-code> + <github-raw> + https://raw.githubusercontent.com/spring-cloud/${docs.main}/${github-tag} + </github-raw> + <github-code>https://github.com/spring-cloud/${docs.main}/tree/${github-tag} + </github-code> <github-issues>https://github.com/spring-cloud/${docs.main}/issues/</github-issues> <github-wiki>https://github.com/spring-cloud/${docs.main}/wiki</github-wiki> - <github-master-code>https://github.com/spring-cloud/${docs.main}/tree/master</github-master-code> + <github-master-code>https://github.com/spring-cloud/${docs.main}/tree/master + </github-master-code> <index-link>${index-link}</index-link> <!-- Spring Cloud specific -->