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

Building docs via included uri

Browse Source
This commit is contained in:
Jean de Klerk
2015-12-16 07:37:51 -07:00
parent 766416b974
commit c964527483
1 changed files with 2 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -6,26 +6,9 @@ include::intro.adoc[]
> NOTE: if you are looking for a way to bind to services then this is the wrong library. Check out the [Spring Cloud Connectors](https://github.com/spring-cloud/spring-cloud-connectors) instead.
= Building documentation
== Building
`./mvnw install -P docs -DskipTests=true --settings .settings.xml`
If there is an ruby error like
--------------------------------------------------------------
LoadError: no such file to load -- asciidoctor
--------------------------------------------------------------
then the user must install the _asciidoctor_ gem and set the environment
variable `GEM_HOME`to the ruby gem folder. For example:
-------------------------------------------------------------
# Get gem info
gem environment
export GEM_HOME=<PATH FOR GEM ENVIRONMENT>
-------------------------------------------------------------
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/building.adoc[]
== Contributing