From 41e47c9995f4e21acee510499566db102b8d8867 Mon Sep 17 00:00:00 2001 From: Dave Syer Date: Mon, 6 Oct 2014 14:58:44 +0100 Subject: [PATCH] Move docs to submodule for multi-module projects --- .travis.yml | 2 +- docs/pom.xml | 44 +++++++++++++++++++ {src => docs/src}/main/asciidoc/README.adoc | 0 {src => docs/src}/main/asciidoc/ghpages.sh | 8 ++-- {src => docs/src}/main/asciidoc/intro.adoc | 0 .../main/asciidoc/spring-cloud-starters.adoc | 0 .../src}/main/ruby/generate_readme.sh | 0 {src => docs/src}/main/ruby/readme.rb | 0 pom.xml | 26 +---------- 9 files changed, 50 insertions(+), 30 deletions(-) create mode 100644 docs/pom.xml rename {src => docs/src}/main/asciidoc/README.adoc (100%) rename {src => docs/src}/main/asciidoc/ghpages.sh (85%) rename {src => docs/src}/main/asciidoc/intro.adoc (100%) rename {src => docs/src}/main/asciidoc/spring-cloud-starters.adoc (100%) rename {src => docs/src}/main/ruby/generate_readme.sh (100%) rename {src => docs/src}/main/ruby/readme.rb (100%) diff --git a/.travis.yml b/.travis.yml index bb5001c..d1a3f36 100644 --- a/.travis.yml +++ b/.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: diff --git a/docs/pom.xml b/docs/pom.xml new file mode 100644 index 0000000..0f5a19d --- /dev/null +++ b/docs/pom.xml @@ -0,0 +1,44 @@ + + + 4.0.0 + org.springframework.cloud + spring-cloud-starter-docs + 1.0.0.BUILD-SNAPSHOT + + org.springframework.cloud + spring-cloud-build + 1.0.0.BUILD-SNAPSHOT + + + pom + Spring Cloud Starter Docs + Spring Cloud Docs + + spring-cloud-cli + ${basedir}/.. + + + + docs + + + + org.asciidoctor + asciidoctor-maven-plugin + false + + + org.apache.maven.plugins + maven-antrun-plugin + false + + + org.codehaus.mojo + build-helper-maven-plugin + false + + + + + + diff --git a/src/main/asciidoc/README.adoc b/docs/src/main/asciidoc/README.adoc similarity index 100% rename from src/main/asciidoc/README.adoc rename to docs/src/main/asciidoc/README.adoc diff --git a/src/main/asciidoc/ghpages.sh b/docs/src/main/asciidoc/ghpages.sh similarity index 85% rename from src/main/asciidoc/ghpages.sh rename to docs/src/main/asciidoc/ghpages.sh index 67da0d2..9190575 100755 --- a/src/main/asciidoc/ghpages.sh +++ b/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 . diff --git a/src/main/asciidoc/intro.adoc b/docs/src/main/asciidoc/intro.adoc similarity index 100% rename from src/main/asciidoc/intro.adoc rename to docs/src/main/asciidoc/intro.adoc diff --git a/src/main/asciidoc/spring-cloud-starters.adoc b/docs/src/main/asciidoc/spring-cloud-starters.adoc similarity index 100% rename from src/main/asciidoc/spring-cloud-starters.adoc rename to docs/src/main/asciidoc/spring-cloud-starters.adoc diff --git a/src/main/ruby/generate_readme.sh b/docs/src/main/ruby/generate_readme.sh similarity index 100% rename from src/main/ruby/generate_readme.sh rename to docs/src/main/ruby/generate_readme.sh diff --git a/src/main/ruby/readme.rb b/docs/src/main/ruby/readme.rb similarity index 100% rename from src/main/ruby/readme.rb rename to docs/src/main/ruby/readme.rb diff --git a/pom.xml b/pom.xml index f1f5b97..1ecc103 100644 --- a/pom.xml +++ b/pom.xml @@ -25,6 +25,7 @@ spring-cloud-starter-security spring-cloud-starter-turbine spring-cloud-starter-zuul + docs @@ -165,30 +166,5 @@ - - - - docs - - - - org.asciidoctor - asciidoctor-maven-plugin - false - - - org.apache.maven.plugins - maven-antrun-plugin - false - - - org.codehaus.mojo - build-helper-maven-plugin - false - - - - -