From 4705d7ff6ed3c596d43cfe78a62276c5d7daca4e Mon Sep 17 00:00:00 2001 From: Dave Syer Date: Mon, 29 Sep 2014 14:12:56 +0100 Subject: [PATCH] Move README to src/main/asciidoc --- README.adoc | 5 ++--- pom.xml | 2 +- src/main/asciidoc/README.adoc | 1 - src/main/ruby/readme.rb | 2 +- 4 files changed, 4 insertions(+), 6 deletions(-) diff --git a/README.adoc b/README.adoc index c5bf4520..23d6b7bb 100644 --- a/README.adoc +++ b/README.adoc @@ -1,5 +1,4 @@ -= Spring Cloud Config - +// Do not edit this file (go to /home/dsyer/dev/cloud/scripts/config/src/main/ruby/../../../src/main/asciidoc/README.adoc instead) Spring Cloud Config provides server and client-side support for externalized configuration in a distributed system. With the Config Server you have a central place to manage external properties for applications across all environments. The concepts on both client and server map identically to the Spring `Environment` and `PropertySource` abstractions, so they fit very well with Spring applications, but can be used with any application running in any language. As an application moves through the deployment pipeline from dev to test and into production you can manage the configuration between those environments and be certain that applications have everything they need to run when they migrate. The default implementation of the server storage backend uses git so it easily supports labelled versions of configuration environments, as well as being accessible to a wide range of tooling for managing the content. It is easy to add alternative implementations and plug them in with Spring configuration. @@ -96,7 +95,7 @@ repository>/" contains the property "foo" with value === Sample Application There is a sample application -https://github.com/spring-cloud/spring-cloud-config-sample[here]. It +https://github.com/spring-cloud/spring-cloud-config/tree/master/spring-cloud-config-sample[here]. It is a Spring Boot application so you can run it using the usual mechanisms (for instance "mvn spring-boot:run"). When it runs it will look for the config server on "http://localhost:8888" by default, so diff --git a/pom.xml b/pom.xml index 5d4f8216..a0ead5e3 100644 --- a/pom.xml +++ b/pom.xml @@ -68,7 +68,6 @@ replacer 1.5.3 - @@ -88,6 +87,7 @@ run + false diff --git a/src/main/asciidoc/README.adoc b/src/main/asciidoc/README.adoc index dbc9740d..f3f2c1b7 100644 --- a/src/main/asciidoc/README.adoc +++ b/src/main/asciidoc/README.adoc @@ -1,4 +1,3 @@ -= Spring Cloud Config include::intro.adoc[] diff --git a/src/main/ruby/readme.rb b/src/main/ruby/readme.rb index e8d8c795..348507c2 100644 --- a/src/main/ruby/readme.rb +++ b/src/main/ruby/readme.rb @@ -31,7 +31,7 @@ module SpringCloud def render_file file, options = {} srcDir = File.dirname(file) - out = [] + out = ["// Do not edit this file (go to #{file} instead)",""] File.new(file).each do |line| self.process(out, srcDir, line) end