From c67caa2b2fb57f41afe70e46c602877991a3e924 Mon Sep 17 00:00:00 2001 From: Dave Syer Date: Fri, 31 Oct 2014 15:59:33 +0000 Subject: [PATCH] Update README with building section --- Guardfile | 3 +-- docs/src/main/asciidoc/README.adoc | 3 +++ docs/src/main/ruby/generate_readme.sh | 2 +- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/Guardfile b/Guardfile index 2c60c3dc..19e40db7 100644 --- a/Guardfile +++ b/Guardfile @@ -1,12 +1,11 @@ require 'asciidoctor' require 'erb' -require './src/main/ruby/readme.rb' options = {:mkdirs => true, :safe => :unsafe, :attributes => 'linkcss'} guard 'shell' do watch(/^src\/[A-Za-z].*\.adoc$/) {|m| - SpringCloud::Build.render_file('src/main/asciidoc/README.adoc', :to_file => './README.adoc') + Asciidoctor.load_file('src/main/asciidoc/README.adoc', :to_file => './README.adoc', safe: :safe, parse: false, attributes: 'allow-uri-read') Asciidoctor.render_file('src/main/asciidoc/spring-cloud-netflix.adoc', options.merge(:to_dir => 'target/generated-docs')) } end diff --git a/docs/src/main/asciidoc/README.adoc b/docs/src/main/asciidoc/README.adoc index 94458649..680f0905 100644 --- a/docs/src/main/asciidoc/README.adoc +++ b/docs/src/main/asciidoc/README.adoc @@ -13,3 +13,6 @@ include::intro.adoc[] * External Configuration: a bridge from the Sprnig Environment to Archaius (enabls native configuration of Netflix components using Spring Boot conventions) * Router and Filter: automatic regsitration of Zuul filters,a nd a simple convention over configuration approach to reverse proxy creation +== Building + +include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/src/main/asciidoc/building.adoc[] diff --git a/docs/src/main/ruby/generate_readme.sh b/docs/src/main/ruby/generate_readme.sh index fc5b7f1a..79aadce4 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 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]