diff --git a/README.adoc b/README.adoc index 51070eb..ebe10f6 100644 --- a/README.adoc +++ b/README.adoc @@ -27,6 +27,27 @@ Services](https://run.pivotal.io)). > 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 + +`./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= + +------------------------------------------------------------- + == Contributing link:https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing.adoc[] \ No newline at end of file diff --git a/docs/src/main/asciidoc/README.adoc b/docs/src/main/asciidoc/README.adoc index 7697635..2127c13 100644 --- a/docs/src/main/asciidoc/README.adoc +++ b/docs/src/main/asciidoc/README.adoc @@ -6,6 +6,27 @@ 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 + +`./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= + +------------------------------------------------------------- + == Contributing include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing.adoc[] \ No newline at end of file diff --git a/docs/src/main/asciidoc/quickstart.adoc b/docs/src/main/asciidoc/quickstart.adoc index 8c60814..0e9767e 100644 --- a/docs/src/main/asciidoc/quickstart.adoc +++ b/docs/src/main/asciidoc/quickstart.adoc @@ -26,5 +26,5 @@ $ spring jar app.jar app.groovy $ cf push -p app.jar ---- -it will show it's app name in the home page. +It will show its app name in the home page. diff --git a/docs/src/main/ruby/generate_readme.sh b/docs/src/main/ruby/generate_readme.sh index d8d8b87..7784d1d 100755 --- a/docs/src/main/ruby/generate_readme.sh +++ b/docs/src/main/ruby/generate_readme.sh @@ -18,7 +18,7 @@ file = ARGV[0] if ARGV.length>0 srcDir = File.dirname(file) out = "// Do not edit this file (e.g. go instead to docs/src/main/asciidoc)\n\n" -doc = Asciidoctor.load_file file, safe: :safe, parse: false +doc = Asciidoctor.load_file file, safe: :safe, parse: false, attributes: 'allow-uri-read' out << doc.reader.read unless options[:to_file]