Move docs to submodule for multi-module projects

.travis.yml

@@ -6,7 +6,7 @@ before_install:
   - echo "https://$GH_TOKEN:@github.com" > .git/credentials
 install:
 - mvn --settings .settings.xml install -P docs -q -U -DskipTests=true -Dmaven.test.redirectTestOutputToFile=true
-- ./src/main/asciidoc/ghpages.sh
+- ./docs/src/main/asciidoc/ghpages.sh
 script: mvn --settings .settings.xml deploy -nsu -Dmaven.test.redirectTestOutputToFile=true
 env:
   global:

docs/README.adoc

@@ -0,0 +1,22 @@
+// Do not edit this file (e.g. go instead to src/main/asciidoc)
+
+
+This project provides Netflix OSS integrations for Spring Boot apps through autoconfiguration
+and binding to the Spring Environment and other Spring programming model idioms. With a few
+simple annotations you can quickly enable and configure the common patterns inside your
+application and build large distributed systems with battle-tested Netflix components. The 
+patterns provided include Service Discovery (Eureka), Circuit Breaker (Hystrix), 
+Intelligent Routing (Zuul) and Client Side Load Balancing (Ribbon).
+
+
+== Features
+
+* Service Discovery: Eureka instances can be registered and clients can discover the instances using Spring-managed beans
+* Service Discovery: an embedded Eureka server can be created with declarative Java configuration
+* Circuit Breaker: Hystrix clients can be built with a simple annotation-driven method decorator
+* Circuit Breaker: embedded Hystrix dashboard with declarative Java configuration
+* Declarative REST Client: Feign creates a dynamic implementation of an interface decorated with JAX-RS or Spring MVC annotations
+* Client Side Load Balancer: Ribbon
+* 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
+

docs/pom.xml

@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<groupId>org.springframework.cloud</groupId>
+	<artifactId>spring-cloud-netflix-docs</artifactId>
+	<version>1.0.0.BUILD-SNAPSHOT</version>
+	<parent>
+		<groupId>org.springframework.cloud</groupId>
+		<artifactId>spring-cloud-build</artifactId>
+		<version>1.0.0.BUILD-SNAPSHOT</version>
+		<relativePath/>
+	</parent>
+	<packaging>pom</packaging>
+	<name>Spring Cloud Netflix Docs</name>
+	<description>Spring Cloud Docs</description>
+	<properties>
+        <docs.main>spring-cloud-netflix</docs.main>
+		<main.basedir>${basedir}/..</main.basedir>
+	</properties>
+    <profiles>
+		<profile>
+			<id>docs</id>
+            <build>
+               <plugins>
+		        <plugin>
+		          <groupId>org.asciidoctor</groupId>
+		          <artifactId>asciidoctor-maven-plugin</artifactId>
+                  <inherited>false</inherited>
+                </plugin>
+			    <plugin>
+				  <groupId>org.apache.maven.plugins</groupId>
+				  <artifactId>maven-antrun-plugin</artifactId>
+                  <inherited>false</inherited>
+                </plugin>
+ 				<plugin>
+				  <groupId>org.codehaus.mojo</groupId>
+				  <artifactId>build-helper-maven-plugin</artifactId>
+                  <inherited>false</inherited>
+                </plugin>
+              </plugins>
+            </build>
+		</profile>
+    </profiles>
+</project>

docs/src/main/asciidoc/ghpages.sh

@@ -7,8 +7,8 @@ if ! (git remote set-branches --add origin gh-pages && git fetch -q); then
     exit 0
 fi
 
-if ! [ -d target/generated-docs ]; then
-    echo "No gh-pages sources in target/generated-docs, so not syncing"
+if ! [ -d docs/target/generated-docs ]; then
+    echo "No gh-pages sources in docs/target/generated-docs, so not syncing"
     exit 0
 fi
 
@@ -22,8 +22,8 @@ if [ "$dirty" != "0" ]; then git stash; fi
 ###################################################################
 git checkout gh-pages
 
-for f in target/generated-docs/*; do
-    file=${f#target/generated-docs/*}
+for f in docs/target/generated-docs/*; do
+    file=${f#docs/target/generated-docs/*}
     if ! git ls-files -i -o --exclude-standard --directory | grep -q ^$file$; then
         # Not ignored...
         cp -rf $f .

pom.xml

@@ -24,6 +24,7 @@
         <module>spring-cloud-netflix-eureka-server</module>
         <module>spring-cloud-netflix-turbine</module>
         <module>spring-cloud-netflix-zuul</module>
+        <module>docs</module>
     </modules>
 
     <dependencyManagement>
@@ -213,29 +214,4 @@
         <zuul.version>1.0.24</zuul.version>
     </properties>
 
-    <profiles>
-		<profile>
-			<id>docs</id>
-            <build>
-               <plugins>
-		        <plugin>
-		          <groupId>org.asciidoctor</groupId>
-		          <artifactId>asciidoctor-maven-plugin</artifactId>
-                  <inherited>false</inherited>
-                </plugin>
-			    <plugin>
-				  <groupId>org.apache.maven.plugins</groupId>
-				  <artifactId>maven-antrun-plugin</artifactId>
-                  <inherited>false</inherited>
-                </plugin>
- 				<plugin>
-				  <groupId>org.codehaus.mojo</groupId>
-				  <artifactId>build-helper-maven-plugin</artifactId>
-                  <inherited>false</inherited>
-                </plugin>
-              </plugins>
-            </build>
-		</profile>
-    </profiles>
-
 </project>