You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by he...@apache.org on 2014/12/17 18:24:02 UTC
[28/50] [abbrv] incubator-brooklyn git commit: new build script which
can write docs to root, to /guide, or to /v/VERSION
new build script which can write docs to root, to /guide, or to /v/VERSION
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/ff06bfe1
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/ff06bfe1
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/ff06bfe1
Branch: refs/heads/master
Commit: ff06bfe11acf56aa6fe3ab031b445dcaf517327a
Parents: f03feef
Author: Alex Heneveld <al...@cloudsoftcorp.com>
Authored: Tue Dec 16 09:26:26 2014 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
Committed: Wed Dec 17 02:02:56 2014 +0000
----------------------------------------------------------------------
docs/_build/build.sh | 90 +++++++++++++++++++++++++++----
docs/_build/config-guide-root.yml | 4 ++
docs/_build/config-guide-version.yml | 7 +++
docs/_build/config-production.yml | 6 +++
docs/_build/jekyll-debug.sh | 6 ---
docs/_build/make-javadoc.sh | 2 +-
docs/_build/preview | 11 ----
7 files changed, 99 insertions(+), 27 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/ff06bfe1/docs/_build/build.sh
----------------------------------------------------------------------
diff --git a/docs/_build/build.sh b/docs/_build/build.sh
index b8b7ed2..d10dc82 100755
--- a/docs/_build/build.sh
+++ b/docs/_build/build.sh
@@ -3,19 +3,91 @@
# this generates the site in _site
# override --url /myMountPoint (as an argument to this script) if you don't like the default set in /_config.yml
-if [ ! -x _scripts/build.sh ] ; then
+if [ ! -x _build/build.sh ] ; then
echo script must be run in root of docs dir
exit 1
fi
-rm -rf _site/
+function help() {
+ echo "This will build the documentation in _site/."
+ echo "Usage: _build/build.sh MODE [ARGS]"
+ echo "where MODE is:"
+ echo "* guide-root : to build the guide in the root"
+ echo "* guide-version : to build the guide in the versioned namespace /v/VERSION/"
+ echo "* default : to build the files in their natural location (e.g. guide in /guide/)"
+ echo "and supported ARGS are:"
+ echo "* --skip-javadoc : to skip javadoc build"
+ echo 'with any remaining ARGS passed to jekyll as `jekyll build --config ... ARGS`.'
+}
-jekyll --pygments $* "$@" || { echo failed jekyll site build ; exit 1 ; }
-echo
+function deduce_config() {
+ DIRS_TO_MOVE=( )
+ case $1 in
+ help)
+ help
+ exit 0 ;;
+ guide-root)
+ CONFIG=_config.yml,_build/config-production.yml,_build/config-guide-root.yml
+ DIRS_TO_MOVE["guide"]=""
+ SUMMARY="user guide files in the root"
+ ;;
+ guide-version)
+ CONFIG=_config.yml,_build/config-production.yml,_build/config-guide-version.yml
+ # Mac bash defaults to v3 not v4, so can't use assoc arrays :(
+ DIRS_TO_MOVE[0]=guide
+ # BROOKLYN_VERSION_BELOW
+ DIRS_TO_MOVE_TARGET[0]=v/0.7.0-SNAPSHOT
+ DIRS_TO_MOVE[1]=style
+ DIRS_TO_MOVE_TARGET[1]=${DIRS_TO_MOVE_TARGET[0]}/style
+ SUMMARY="user guide files in /${DIRS_TO_MOVE_TARGET[0]}"
+ ;;
+ default)
+ CONFIG=_config.yml,_build/config-production.yml
+ SUMMARY="all files in their default place"
+ ;;
+ "")
+ echo "Arguments are required. Try 'help'."
+ exit 1 ;;
+ *)
+ echo "Invalid argument '$1'. Try 'help'."
+ exit 1 ;;
+ esac
+}
-pushd _javadoc > /dev/null
-./make-javadoc.sh || { echo failed javadoc build ; exit 1 ; }
-popd > /dev/null
-echo
+function build_jekyll() {
+ echo JEKYLL running with: jekyll build $CONFIG $@
+ jekyll build --config $CONFIG $@ || return 1
+ echo JEKYLL completed
+ for DI in "${!DIRS_TO_MOVE[@]}"; do
+ D=${DIRS_TO_MOVE[$DI]}
+ DT=${DIRS_TO_MOVE_TARGET[$DI]}
+ echo moving _site/$D/ to _site/$DT
+ mkdir -p _site/$DT
+ # the generated files are already in _site/ due to url rewrites along the way, but images etc are not
+ cp -r _site/$D/* _site/$DT
+ rm -rf _site/$D
+ done
+ rm -rf _site/long_grass
+}
-echo docs build complete, in _site
+rm -rf _site
+
+deduce_config $@
+shift
+
+if [ "$1" = "--skip-javadoc" ]; then
+ SKIP_JAVADOC=true
+ shift
+fi
+
+build_jekyll || { echo ERROR: could not build docs in `pwd` ; exit 1 ; }
+
+if [ "$SKIP_JAVADOC" != "true" ]; then
+ pushd _build > /dev/null
+ ./make-javadoc.sh || { echo ERROR: failed javadoc build ; exit 1 ; }
+ popd > /dev/null
+fi
+
+# TODO build catalog
+
+echo FINISHED: $SUMMARY of `pwd`/_site
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/ff06bfe1/docs/_build/config-guide-root.yml
----------------------------------------------------------------------
diff --git a/docs/_build/config-guide-root.yml b/docs/_build/config-guide-root.yml
new file mode 100644
index 0000000..64bd67f
--- /dev/null
+++ b/docs/_build/config-guide-root.yml
@@ -0,0 +1,4 @@
+
+path:
+ guide: ""
+
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/ff06bfe1/docs/_build/config-guide-version.yml
----------------------------------------------------------------------
diff --git a/docs/_build/config-guide-version.yml b/docs/_build/config-guide-version.yml
new file mode 100644
index 0000000..5e4acc0
--- /dev/null
+++ b/docs/_build/config-guide-version.yml
@@ -0,0 +1,7 @@
+
+path:
+ # BROOKLYN_VERSION_BELOW
+ guide: /v/0.7.0-SNAPSHOT
+ # BROOKLYN_VERSION_BELOW
+ style: /v/0.7.0-SNAPSHOT/style
+
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/ff06bfe1/docs/_build/config-production.yml
----------------------------------------------------------------------
diff --git a/docs/_build/config-production.yml b/docs/_build/config-production.yml
new file mode 100644
index 0000000..5aaf12d
--- /dev/null
+++ b/docs/_build/config-production.yml
@@ -0,0 +1,6 @@
+
+url: https://brooklyn.incubator.apache.org
+
+dependency_mode: remote
+
+
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/ff06bfe1/docs/_build/jekyll-debug.sh
----------------------------------------------------------------------
diff --git a/docs/_build/jekyll-debug.sh b/docs/_build/jekyll-debug.sh
deleted file mode 100755
index 4654098..0000000
--- a/docs/_build/jekyll-debug.sh
+++ /dev/null
@@ -1,6 +0,0 @@
-#!/bin/bash
-#
-# launches jekyll as a server at the / location, for easy debug
-
-jekyll --pygments --server --auto --url "" $*
-
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/ff06bfe1/docs/_build/make-javadoc.sh
----------------------------------------------------------------------
diff --git a/docs/_build/make-javadoc.sh b/docs/_build/make-javadoc.sh
index 2f9da56..4df6462 100755
--- a/docs/_build/make-javadoc.sh
+++ b/docs/_build/make-javadoc.sh
@@ -32,7 +32,7 @@ ant.groovydoc(
windowtitle : "\${title}",
doctitle : "\${title}",
header : "\${title}",
- footer : '<b>Brooklyn Multi-Cloud Application Management Platform</b> <br/> <a href="http://brooklyncentral.github.com/" target="_top">brooklyncentral.github.com</a>. Apache License. © 2012.',
+ footer : '<b>Apache Brooklyn - Multi-Cloud Application Management Platform</b> <br/> <a href="http://brooklyn.io/" target="_top">brooklyn.io</a>. Apache License. © 2014.',
private : "false")
println "\njavadoc built in target/apidocs\n"
END
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/ff06bfe1/docs/_build/preview
----------------------------------------------------------------------
diff --git a/docs/_build/preview b/docs/_build/preview
deleted file mode 100755
index 418f753..0000000
--- a/docs/_build/preview
+++ /dev/null
@@ -1,11 +0,0 @@
-#!/bin/bash -e
-
-# for newer version of jekyll, based on what is used for incubator-brooklyn-site
-
-set -x
-
-echo > _config_local.yml "url: "
-
-rm -rf _site
-
-jekyll serve --config _config_local.yml --watch