Added info about attributes
This commit is contained in:
11
README.adoc
11
README.adoc
@@ -6,6 +6,10 @@ Edit the files in the src/main/asciidoc/ directory instead.
|
||||
|
||||
image:https://circleci.com/gh/spring-cloud/spring-cloud-build.svg?style=svg[link="https://travis-ci.org/spring-cloud/spring-cloud-build"]
|
||||
|
||||
project-name:spring-cloud-build
|
||||
github-tag:master
|
||||
github-raw:https://raw.github.com/spring-cloud/{project-name}/{github-tag}
|
||||
|
||||
Spring Cloud Build is a common utility project for Spring Cloud
|
||||
to use for plugin and dependency management.
|
||||
|
||||
@@ -273,6 +277,13 @@ approach of generating documentation just add these plugins to your `docs` modul
|
||||
|
||||
IMPORTANT: The order of plugin declaration is important!
|
||||
|
||||
Spring Cloud Build Docs comes with a set of attributes for asciidoctor that you can reuse.
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
Unresolved directive in README.adoc - include::{github-raw}/pom.xml[tags=attributes,indent=0]
|
||||
----
|
||||
|
||||
== Updating the guides
|
||||
|
||||
We assume that your project contains guides under the `guides` folder.
|
||||
|
||||
@@ -1,5 +1,9 @@
|
||||
image:https://circleci.com/gh/spring-cloud/spring-cloud-build.svg?style=svg[link="https://travis-ci.org/spring-cloud/spring-cloud-build"]
|
||||
|
||||
project-name:spring-cloud-build
|
||||
github-tag:master
|
||||
github-raw:https://raw.github.com/spring-cloud/{project-name}/{github-tag}
|
||||
|
||||
Spring Cloud Build is a common utility project for Spring Cloud
|
||||
to use for plugin and dependency management.
|
||||
|
||||
@@ -89,6 +93,13 @@ approach of generating documentation just add these plugins to your `docs` modul
|
||||
|
||||
IMPORTANT: The order of plugin declaration is important!
|
||||
|
||||
Spring Cloud Build Docs comes with a set of attributes for asciidoctor that you can reuse.
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
include::{github-raw}/pom.xml[tags=attributes,indent=0]
|
||||
----
|
||||
|
||||
== Updating the guides
|
||||
|
||||
We assume that your project contains guides under the `guides` folder.
|
||||
|
||||
4
pom.xml
4
pom.xml
@@ -1023,6 +1023,7 @@
|
||||
</excludes>
|
||||
</resource>
|
||||
</resources>
|
||||
<!-- tag::attributes[] -->
|
||||
<attributes>
|
||||
<docinfo>shared</docinfo>
|
||||
<allow-uri-read>true</allow-uri-read>
|
||||
@@ -1034,7 +1035,9 @@
|
||||
<asciidoc-sources-root>${project.basedir}/src/main/asciidoc</asciidoc-sources-root>
|
||||
<generated-resources-root>${project.basedir}/target/generated-resources
|
||||
</generated-resources-root>
|
||||
<!-- Use this attribute the reference code from another module -->
|
||||
<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.github.com/spring-cloud/${docs.main}/${github-tag}</github-raw>
|
||||
<github-code>https://github.com/spring-cloud/${docs.main}/tree/${github-tag}</github-code>
|
||||
@@ -1052,6 +1055,7 @@
|
||||
<project-version>${project.version}</project-version>
|
||||
<project-name>${docs.main}</project-name>
|
||||
</attributes>
|
||||
<!-- end::attributes[] -->
|
||||
<requires>
|
||||
<require>asciidoctor-diagram</require>
|
||||
</requires>
|
||||
|
||||
Reference in New Issue
Block a user