diff --git a/.travis.yml b/.travis.yml index 6f50d11..37ee4b9 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/README.adoc b/docs/README.adoc new file mode 100644 index 0000000..8ef6354 --- /dev/null +++ b/docs/README.adoc @@ -0,0 +1,41 @@ +// Do not edit this file (e.g. go instead to src/main/asciidoc) + +Spring Boot command line features for +https://github.com/spring-cloud[Spring Cloud]. + + +== Installation + +To install, make +sure you have +https://github.com/spring-projects/spring-boot[Spring Boot CLI] +(1.1.x with x>=5): + + $ spring version + Spring CLI v1.1.5.RELEASE + +E.g. for GVM users + +``` +$ gvm install springboot 1.1.5.RELEASE +$ gvm use springboot 1.1.5.RELEASE +``` + +then get the install command plugin (backported from Boot 1.2.0): + +``` +$ wget http://dl.bintray.com/dsyer/generic/install-0.0.1.jar +``` + +install it in the Spring Boot CLI, e.g. with GVM (MacOS users that rely on brew might have to find the `/lib` directory by scanning `brew info springboot`): + +``` +$ cp install-0.0.1.jar ~/.gvm/springboot/1.1.5.RELEASE/lib +``` + +and finally install the Spring Cloud plugin: + +``` +$ mvn install +$ spring install org.springframework.cloud:spring-cloud-cli:1.0.0.BUILD-SNAPSHOT +``` diff --git a/docs/pom.xml b/docs/pom.xml new file mode 100644 index 0000000..6583502 --- /dev/null +++ b/docs/pom.xml @@ -0,0 +1,44 @@ + + + 4.0.0 + org.springframework.cloud + spring-cloud-cli-docs + 1.0.0.BUILD-SNAPSHOT + + org.springframework.cloud + spring-cloud-build + 1.0.0.BUILD-SNAPSHOT + + + pom + Spring Cloud Cli 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/install.adoc b/docs/src/main/asciidoc/install.adoc similarity index 100% rename from src/main/asciidoc/install.adoc rename to docs/src/main/asciidoc/install.adoc 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-cli.adoc b/docs/src/main/asciidoc/spring-cloud-cli.adoc similarity index 100% rename from src/main/asciidoc/spring-cloud-cli.adoc rename to docs/src/main/asciidoc/spring-cloud-cli.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 fff2852..5e3a986 100644 --- a/pom.xml +++ b/pom.xml @@ -25,6 +25,7 @@ spring-cloud-versions spring-cloud-cli + docs @@ -44,28 +45,4 @@ - - - docs - - - - org.asciidoctor - asciidoctor-maven-plugin - false - - - org.apache.maven.plugins - maven-antrun-plugin - false - - - org.codehaus.mojo - build-helper-maven-plugin - false - - - - -