From 8e737416570c4bc1a68a7408ffbd8e564955d3f1 Mon Sep 17 00:00:00 2001
From: Marcin Grzejszczak <marcin@grzejszczak.pl>
Date: Tue, 30 Jul 2019 09:32:52 +0200
Subject: [PATCH] Added info about attributes

---
 README.adoc                        | 11 +++++++++++
 docs/src/main/asciidoc/README.adoc | 11 +++++++++++
 pom.xml                            |  4 ++++
 3 files changed, 26 insertions(+)

diff --git a/README.adoc b/README.adoc
index 287c11b1..09875a3b 100644
--- a/README.adoc
+++ b/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.
diff --git a/docs/src/main/asciidoc/README.adoc b/docs/src/main/asciidoc/README.adoc
index 9c861347..1469f979 100644
--- a/docs/src/main/asciidoc/README.adoc
+++ b/docs/src/main/asciidoc/README.adoc
@@ -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.
diff --git a/pom.xml b/pom.xml
index c5cddbb9..7316a289 100644
--- a/pom.xml
+++ b/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>