SpringCloud/spring-cloud-build
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added info about attributes

Browse Source
This commit is contained in:
Marcin Grzejszczak
2019-07-30 09:55:25 +02:00
parent 8e73741657
commit 7de33c920c
3 changed files with 33 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.adoc
View File

@@ -6,10 +6,6 @@ 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.
@@ -281,7 +277,37 @@ Spring Cloud Build Docs comes with a set of attributes for asciidoctor that you
[source,xml]
----
Unresolved directive in README.adoc - include::{github-raw}/pom.xml[tags=attributes,indent=0]
<attributes>
<docinfo>shared</docinfo>
<allow-uri-read>true</allow-uri-read>
<nofooter/>
<toc>left</toc>
<toc-levels>4</toc-levels>
<sectlinks>true</sectlinks>
<sources-root>${project.basedir}/src</sources-root>
<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>
<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>
<index-link>${index-link}</index-link>
<!-- Spring Cloud specific -->
<project-version>${project.version}</project-version>
<github-tag>${github-tag}</github-tag>
<version-type>${version-type}</version-type>
<docs-url>${docs-url}</docs-url>
<raw-docs-url>${raw-docs-url}</raw-docs-url>
<project-version>${project.version}</project-version>
<project-name>${docs.main}</project-name>
</attributes>
----
== Updating the guides

6
docs/src/main/asciidoc/README.adoc
View File

@@ -1,9 +1,5 @@
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.
@@ -97,7 +93,7 @@ Spring Cloud Build Docs comes with a set of attributes for asciidoctor that you
[source,xml]
----
include::{github-raw}/pom.xml[tags=attributes,indent=0]
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/pom.xml[tags=attributes,indent=0]
----
== Updating the guides

2
pom.xml
View File

@@ -1039,7 +1039,7 @@
<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-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>