diff --git a/README.adoc b/README.adoc index 4e9d9593..dc335b43 100644 --- a/README.adoc +++ b/README.adoc @@ -278,7 +278,9 @@ approach of generating documentation just add these plugins to your `docs` modul IMPORTANT: 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. +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 (configurable via the `configprops.path` property). + +If you want to modify which of the configuration properties are put in the table, you can tweak the `configprops.inclusionPattern` pattern to include only a subset of the properties (e.g. `spring.sleuth.*`). Spring Cloud Build Docs comes with a set of attributes for asciidoctor that you can reuse. @@ -299,11 +301,15 @@ Spring Cloud Build Docs comes with a set of attributes for asciidoctor that you ${maven.multiModuleProjectDirectory} ${docs.main} - https://raw.githubusercontent.com/spring-cloud/${docs.main}/${github-tag} - https://github.com/spring-cloud/${docs.main}/tree/${github-tag} + + https://raw.githubusercontent.com/spring-cloud/${docs.main}/${github-tag} + + https://github.com/spring-cloud/${docs.main}/tree/${github-tag} + https://github.com/spring-cloud/${docs.main}/issues/ https://github.com/spring-cloud/${docs.main}/wiki - https://github.com/spring-cloud/${docs.main}/tree/master + https://github.com/spring-cloud/${docs.main}/tree/master + ${index-link} diff --git a/docs/src/main/groovy/org/springframework/cloud/internal/Main.groovy b/docs/src/main/groovy/org/springframework/cloud/internal/Main.groovy index bc101386..ae07afbc 100644 --- a/docs/src/main/groovy/org/springframework/cloud/internal/Main.groovy +++ b/docs/src/main/groovy/org/springframework/cloud/internal/Main.groovy @@ -55,10 +55,9 @@ class Main { new File(outputFile).text = """\ |=== |Name | Default | Description + ${names.collect { it -> return descriptions[it] }.join("\n")} - - |=== """ println "Successfully stored the output file"