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:05 UTC
[31/50] [abbrv] incubator-brooklyn git commit: updated README and
added options to build.sh for building the website, guide, or both
updated README and added options to build.sh for building the website, guide, or both
and corresponding `_build/config-*` files and tweaks elsewhere
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/08068213
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/08068213
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/08068213
Branch: refs/heads/master
Commit: 08068213e1bd5cb6f223c89a1363010b37805c92
Parents: 09b7b58
Author: Alex Heneveld <al...@cloudsoftcorp.com>
Authored: Tue Dec 16 17:07:34 2014 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
Committed: Wed Dec 17 02:02:57 2014 +0000
----------------------------------------------------------------------
docs/README.md | 180 +++++++++++++++++-----
docs/_build/build.sh | 72 +++++----
docs/_build/config-exclude-all-but-guide.yml | 1 +
docs/_build/config-exclude-guide.yml | 1 +
docs/_build/config-guide-latest.yml | 2 +
docs/_build/config-guide-root.yml | 2 -
docs/_build/config-guide-version.yml | 1 -
docs/_build/config-production.yml | 3 +-
docs/_build/config-style-latest.yml | 2 +
docs/_build/config-subpath-brooklyn.yml | 9 ++
docs/_build/config-website-root.yml | 2 -
docs/_config.yml | 6 +-
docs/_old/_config.yml | 24 ---
docs/_plugins/site_structure.rb | 1 +
docs/index.md | 3 +-
15 files changed, 208 insertions(+), 101 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08068213/docs/README.md
----------------------------------------------------------------------
diff --git a/docs/README.md b/docs/README.md
index 6cac8b0..ece1396 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,13 +1,12 @@
-Brooklyn Website source
-=======================
+Brooklyn Website and Docs Source
+================================
-Contributor worflow
--------------------
+Contributor Workflow
+--------------------
The contributor workflow is identical to that used by the main project, with
-the exception of the different repository - `incubator-brooklyn-site` instead
-of `incubator-brooklyn`. Therefore you should familiarise yourself with the
-standard workflow for Apache Brooklyn:
+pull requests and contributor licenses requried. Therefore you should
+familiarise yourself with the standard workflow for Apache Brooklyn:
* [Guide for contributors][CONTRIB]
* [Guide for committers][COMMIT]
@@ -16,11 +15,11 @@ standard workflow for Apache Brooklyn:
[COMMIT]: https://brooklyn.incubator.apache.org/community/committers.html
-Workstation setup
+Workstation Setup
-----------------
-First, clone the `incubator-brooklyn-site` repository and set up the remotes as
-described in [Guide for committers][COMMIT].
+First, if you have not already done so, clone the `incubator-brooklyn` repository
+and set up the remotes as described in [Guide for committers][COMMIT].
Install [RVM](http://rvm.io/); this manages Ruby installations and sets of Ruby
gems.
@@ -29,7 +28,7 @@ gems.
At this point, close your shell session and start a new one, to get the new
environment that RVM has configured. Now change directory to the location where
-you checked out your repository, and then to the `_scripts` subdirectory.
+you checked out your repository, and then to the `docs/_build` subdirectory.
RVM should detect its configuration inside `Gemfile` and try to configure itself.
Most likely it will report that the required version of Ruby is not installed;
@@ -37,70 +36,177 @@ it will show the command that you need to run to install the correct version.
Follow these instructions.
Once the correct version of Ruby is installed, change to your home directory
-(`cd ~`) and then change back to the repository again (`cd -`). This will cause
+(`cd ~`) and then change back to the `_build` dir again (`cd -`). This will cause
RVM to re-load configuration from `Gemfile` with the correct version of Ruby.
If you are running Ubuntu, there is a further dependency that is required:
sudo apt-get install libxslt-dev libxml2-dev
-Finally, run this command inside `_scripts` to install all the required Gems
-in the correct versions:
+Finally, run this command inside `_build` to install all the required Gems
+at the correct versions:
bundle install
-Anytime you need to reset your Ruby environment for jekyll to run correctly,
-return to the `_scripts` directory and re-run the above command.
+Any time you need to reset your Ruby environment for jekyll to run correctly,
+return to the `_build` directory and re-run the above command.
-Building and previewing the website
+Building and Previewing the Website
-----------------------------------
### Using Jekyll's in-built server
-Run the command:
+In the `docs` directory, run the command:
jekyll serve --watch
This will start up a local web server. The URL is printed by Jekyll when the server starts,
-e.g. http://localhost:4000/brooklyn/ . The server will continue to run until you press Ctrl+C.
+e.g. http://localhost:4000/ . The server will continue to run until you press Ctrl+C.
Modified files will be detected and regenerated (but that might take up to 1m).
-Leave off the `--watch` argument to abandon that behaviour, or use `jekyll build` instead
+Leave off the `--watch` argument to turn off regeneration, or use `jekyll build` instead
to generate a site in `_site` without a server, for instance if your browser supports running from disk.
+Project Structure
+-----------------
-### Combining with Brooklyn user-manual / version docs
+Note that there are two interlinked micro-sites in this project:
-TODO: Some links should come from the incubator-brooklyn/docs/ project.
-They can run in debug mode on a different port.
+* `/website`: this contains the main Brooklyn website, including committer instructions,
+ download instructions, and "learn more" pages;
+ this content has **only one instance** on the live website,
+ and as changes are published they replace old content
+
+* `/guide`: this contains the user guide and information pertaining to a
+ specific Brooklyn version, including code structure and API documentation;
+ the live website contains a **copy of the guide for each Brooklyn version**,
+ with the code coming from the corresponding branch in `git`
+In addition note the following folders:
-Building and publishing the website
------------------------------------
+* `/style`: contains JS, CSS, and image resources;
+ on the live website, this folder is installed at the root *and*
+ into archived versions of the guide.
+
+* `/_build`: contains build scripts and configuration files,
+ and tests for some of the plugins
+
+* `/_plugins`: contains Jekyll plugins which supply tags and generation
+ logic for the sites, including links and tables of contents
+
+* `/_layouts`: contains HTML templates used by pages
+
+* `/_includes`: contains miscellaneous content used by templates and pages
+
+Jekyll automatically excludes any file or folder beginning with `_`
+from direct processing, so these do *not* show up in the `_site` folder
+(except where they are embedded in other files).
+
+**A word on branches:** The `/website` folder can be built against any branch;
+typically changes are made and published from `master`, to ensure that all versions
+are listed correctly.
+In contrast the `/guide` folder should be updated and built against the branch for which
+instructions are being made, e.g. `master` for latest snapshot updates,
+or `0.7.0-M2` for that milestone release.
+It *is* permitted to make changes to docs (and docs only!) after a release has
+been made. In most cases, these changes should also be made to master.
+
+
+Website Structure
+-----------------
+
+The two micro-sites above are installed on the live website as follows:
+
+* `/`: contains the website
+* `/v/<version>`: contains specific versions of the guide,
+ with the special folder `/v/latest` containing the recent preferred stable/milestone version
+
+The site itself is hosted at `brooklyn.incubator.apache.org` with a `CNAME`
+record from `brooklyn.io`.
+
+Content is published to the site by updating an
+Apache subversion repository, `incubator-brooklyn-site-public` at
+`https://svn.apache.org/repos/asf/incubator/brooklyn/site`.
+See below for more information.
+
+
+Building the Website and Guide
+------------------------------
+
+For most users, the `jekyll serve` command described above is sufficient to test changes locally.
+The main reason to use the build scripts (and to read this section) is to push changes to the server.
+This power is reserved to Brooklyn committers.
-Run this script:
+The build is controlled by config files in `_build/` and accessed through `_build/build.sh`.
+There are a number of different builds possible; to list these, run:
- ./_scripts/build-for-publication
+ _build/build.sh help
-This will run Jekyll with the correct base URL for the live website and place
-the output in the `_site` directory.
+The normal build outputs to `_site/`. The three builds which are relevant to updating the live site are:
-The Apache website publication process is based around the Subversion repository; the generated HTML files must be checked in to Subversion, whereupon an automated process will publish the files to the live website.
+* **website-root**: to build the website only, in the root
+* **guide-latest**: to build the guide only, in `/v/latest/`
+* **guide-version**: to build the guide only, in the versioned namespace e.g. `/v/<version>/`
-Starting in a suitable directory, check out the website directory from the repository:
+Publishing the Website and Guide
+--------------------------------
+The Apache website publication process is based around the Subversion repository;
+the generated HTML files must be checked in to Subversion, whereupon an automated process
+will publish the files to the live website.
+So, to push changes the live site, you will need to have the website directory checked out
+from the Apache subversion repository. We recommend setting this up as a sibling to your
+`incubator-brooklyn` git project directory:
+
+ # verify we're in the right location and the site does not already exist
+ ls _build/build.sh || { echo "ERROR: you should be in the docs/ directory to run this command" ; exit 1 }
+ ls ../../incubator-brooklyn-site-public && { echo "ERROR: incubator-brooklyn-site-public dir already exists ; exit 1 }
+ pushd ../..
+
svn co https://svn.apache.org/repos/asf/incubator/brooklyn/site incubator-brooklyn-site-public
+
+ # verify it
cd incubator-brooklyn-site-public
+ ls style/css/website.css || { echo "ERROR: checkout is wrong" ; exit 1 }
+ export BROOKLYN_SITE_DIR=`pwd`
+ popd
+ echo "SUCCESS: checked out site in $BROOKLYN_SITE_DIR"
-Synchronise the generated site into the Subversion working copy - please amend this command to include the correct paths for your setup:
+With this checked out, the `build.sh` script can automatically copy generated files into the right subversion sub-directories
+with the `--install` option. (This assumes the relative structure described above; if you have a different
+structure, set BROOKLYN_SITE_DIR to point to the directory as above. Alternatively you can copy files manually,
+using the instructions in `build.sh` as a guide.)
- rsync -rv --delete --exclude .svn --exclude v ~/incubator-brooklyn-site/_site/ ~/incubator-brooklyn-site-public
+**TODO: the `--install` option below is not yet implemented**
+
+A typical update consists of the following commands (or a subset),
+copied to `${BROOKLYN_SITE_DIR:../../incubator-brooklyn-site-public}`:
+
+ # main website, relative to /
+ _build/build.sh website-root --install
+
+ # latest guide, relative to /v/latest/
+ _build/build.sh guide-latest --install
+
+ # latest guide, relative to /v/<version>/
+ _build/build.sh guide-version --install
+
+Next it is recommended to go to the SVN dir and
+review the changes using the usual `svn` commands -- `status`, `diff`, `add`, `rm`, etc:
+
+ cd ${BROOKLYN_SITE_DIR:../../incubator-brooklyn-site-public}
+
+You must then check in the changes:
-Review the changes using the usual `svn` commands - e.g., `status`, `diff`, `add`, `rm`, etc.
+ svn ci -m 'Update Brooklyn website'
-Once you are ready to publish, commit the changes to Subversion:
+The changes should become live within a few minutes.
- svn ci -m 'Update Brooklyn (incubating) website'
-The changes will become live within a few minutes.
+<!-- OLD notes:
+
+Synchronise the generated site into the Subversion working copy - please amend this command to include the correct paths for your setup:
+
+ rsync -rv --delete --exclude .svn --exclude v ~/incubator-brooklyn-site/_site/ ~/incubator-brooklyn-site-public
+-->
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08068213/docs/_build/build.sh
----------------------------------------------------------------------
diff --git a/docs/_build/build.sh b/docs/_build/build.sh
index 4dfe7cd..c3f9068 100755
--- a/docs/_build/build.sh
+++ b/docs/_build/build.sh
@@ -12,12 +12,14 @@ function help() {
echo "This will build the documentation in _site/."
echo "Usage: _build/build.sh MODE [ARGS]"
echo "where MODE is:"
- echo "* root : to build root files for production, the website in the root and guide in /guide/"
+ echo "* website-root : to build the website only, in the root"
+ echo "* guide-latest : to build the guide only, in /v/latest/"
# BROOKLYN_VERSION_BELOW
- echo "* guide-version : to build a versioned guide for production; guide only, in the versioned namespace /v/0.7.0-SNAPSHOT/"
- echo "* website-root : to build the website only, in the root"
- echo "* guide-root : to build the guide only, in the root"
- echo "* original : to build the files in their original location (e.g. guide in /guide/)"
+ echo "* guide-version : to build the guide only, in the versioned namespace /v/0.7.0-SNAPSHOT/"
+ echo "* test-guide-root : to build the guide only, in the root (for testing)"
+ echo "* test-both : to build the website to root and guide to /v/latest/ (for testing)"
+ echo "* test-both-sub : to build the website to /sub/ and guide to /sub/v/latest/ (for testing)"
+ echo "* original : to build the files in their original location (website it /website and guide in /guide/, for testing)"
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`.'
@@ -29,44 +31,60 @@ function deduce_config() {
help)
help
exit 0 ;;
- root)
- CONFIG=_config.yml,_build/config-production.yml,_build/config-website-root.yml
- DIRS_TO_MOVE[0]=website
- DIRS_TO_MOVE_TARGET[0]=""
- JAVADOC_TARGET=_site/guide/use/api/
- SUMMARY="root production files, website in root and guide in /guide/"
- ;;
website-root)
- CONFIG=_config.yml,_build/config-production.yml,_build/config-website-root.yml
+ CONFIG=_config.yml,_build/config-production.yml,_build/config-exclude-guide.yml,_build/config-website-root.yml
DIRS_TO_MOVE[0]=website
DIRS_TO_MOVE_TARGET[0]=""
- DIRS_TO_MOVE[1]=guide
- DIRS_TO_MOVE_TARGET[1]=long_grass
SKIP_JAVADOC=true
- SUMMARY="user guide files in the root"
+ SUMMARY="website files in the root"
;;
- guide-root)
- CONFIG=_config.yml,_build/config-production.yml,_build/config-guide-root.yml
+ guide-latest)
+ CONFIG=_config.yml,_build/config-production.yml,_build/config-exclude-all-but-guide.yml,_build/config-guide-latest.yml,_build/config-style-latest.yml
DIRS_TO_MOVE[0]=guide
- DIRS_TO_MOVE_TARGET[0]=""
- DIRS_TO_MOVE[1]=website
- DIRS_TO_MOVE_TARGET[1]=long_grass
- JAVADOC_TARGET=_site/use/api/
- SUMMARY="user guide files in the root"
+ DIRS_TO_MOVE_TARGET[0]=v/latest
+ DIRS_TO_MOVE[1]=style
+ DIRS_TO_MOVE_TARGET[1]=v/latest/style
+ JAVADOC_TARGET=_site/${DIRS_TO_MOVE_TARGET[0]}/use/api/
+ SUMMARY="user guide files in /${DIRS_TO_MOVE_TARGET[0]}"
;;
guide-version)
- CONFIG=_config.yml,_build/config-production.yml,_build/config-guide-version.yml
+ CONFIG=_config.yml,_build/config-production.yml,_build/config-exclude-all-but-guide.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
- DIRS_TO_MOVE[2]=website
- DIRS_TO_MOVE_TARGET[2]=long_grass
- JAVADOC_TARGET=_site/${DIRS_TO_MOVE_TARGET[1]}/use/api/
+ JAVADOC_TARGET=_site/${DIRS_TO_MOVE_TARGET[0]}/use/api/
SUMMARY="user guide files in /${DIRS_TO_MOVE_TARGET[0]}"
;;
+ test-guide-root)
+ CONFIG=_config.yml,_build/config-production.yml,_build/config-exclude-all-but-guide.yml,_build/config-guide-root.yml
+ DIRS_TO_MOVE[0]=guide
+ DIRS_TO_MOVE_TARGET[0]=""
+ JAVADOC_TARGET=_site/use/api/
+ SUMMARY="user guide files in the root"
+ ;;
+ test-both)
+ CONFIG=_config.yml,_build/config-production.yml,_build/config-website-root.yml,_build/config-guide-latest.yml
+ DIRS_TO_MOVE[0]=guide
+ DIRS_TO_MOVE_TARGET[0]=v/latest
+ DIRS_TO_MOVE[1]=website
+ DIRS_TO_MOVE_TARGET[1]=""
+ JAVADOC_TARGET=_site/${DIRS_TO_MOVE_TARGET[0]}/use/api/
+ SUMMARY="all files, website in root and guide in /${DIRS_TO_MOVE_TARGET[0]}"
+ ;;
+ test-both-sub)
+ CONFIG=_config.yml,_build/config-production.yml,_build/config-subpath-brooklyn.yml
+ DIRS_TO_MOVE[0]=guide
+ DIRS_TO_MOVE_TARGET[0]=brooklyn/v/latest
+ DIRS_TO_MOVE[1]=website
+ DIRS_TO_MOVE_TARGET[1]=brooklyn
+ DIRS_TO_MOVE[2]=style
+ DIRS_TO_MOVE_TARGET[2]=brooklyn/style
+ JAVADOC_TARGET=_site/${DIRS_TO_MOVE_TARGET[0]}/use/api/
+ SUMMARY="all files in /brooklyn"
+ ;;
original)
CONFIG=_config.yml,_build/config-production.yml
SUMMARY="all files in their original place"
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08068213/docs/_build/config-exclude-all-but-guide.yml
----------------------------------------------------------------------
diff --git a/docs/_build/config-exclude-all-but-guide.yml b/docs/_build/config-exclude-all-but-guide.yml
new file mode 100644
index 0000000..7ed3c5a
--- /dev/null
+++ b/docs/_build/config-exclude-all-but-guide.yml
@@ -0,0 +1 @@
+exclude: ['/LICENSE.txt','/README.md','/index.md','/favicon.ico','/website']
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08068213/docs/_build/config-exclude-guide.yml
----------------------------------------------------------------------
diff --git a/docs/_build/config-exclude-guide.yml b/docs/_build/config-exclude-guide.yml
new file mode 100644
index 0000000..373dc76
--- /dev/null
+++ b/docs/_build/config-exclude-guide.yml
@@ -0,0 +1 @@
+exclude: ['/LICENSE.txt','/README.md','/guide']
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08068213/docs/_build/config-guide-latest.yml
----------------------------------------------------------------------
diff --git a/docs/_build/config-guide-latest.yml b/docs/_build/config-guide-latest.yml
new file mode 100644
index 0000000..8b20811
--- /dev/null
+++ b/docs/_build/config-guide-latest.yml
@@ -0,0 +1,2 @@
+path:
+ guide: /v/latest
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08068213/docs/_build/config-guide-root.yml
----------------------------------------------------------------------
diff --git a/docs/_build/config-guide-root.yml b/docs/_build/config-guide-root.yml
index 64bd67f..f45a593 100644
--- a/docs/_build/config-guide-root.yml
+++ b/docs/_build/config-guide-root.yml
@@ -1,4 +1,2 @@
-
path:
guide: ""
-
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08068213/docs/_build/config-guide-version.yml
----------------------------------------------------------------------
diff --git a/docs/_build/config-guide-version.yml b/docs/_build/config-guide-version.yml
index 5e4acc0..03b654d 100644
--- a/docs/_build/config-guide-version.yml
+++ b/docs/_build/config-guide-version.yml
@@ -1,4 +1,3 @@
-
path:
# BROOKLYN_VERSION_BELOW
guide: /v/0.7.0-SNAPSHOT
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08068213/docs/_build/config-production.yml
----------------------------------------------------------------------
diff --git a/docs/_build/config-production.yml b/docs/_build/config-production.yml
index 5aaf12d..fe2065b 100644
--- a/docs/_build/config-production.yml
+++ b/docs/_build/config-production.yml
@@ -1,6 +1,5 @@
+# in production we always set the URL and dependencies should come from the remote source
url: https://brooklyn.incubator.apache.org
dependency_mode: remote
-
-
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08068213/docs/_build/config-style-latest.yml
----------------------------------------------------------------------
diff --git a/docs/_build/config-style-latest.yml b/docs/_build/config-style-latest.yml
new file mode 100644
index 0000000..d03b87d
--- /dev/null
+++ b/docs/_build/config-style-latest.yml
@@ -0,0 +1,2 @@
+path:
+ style: /v/latest/style
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08068213/docs/_build/config-subpath-brooklyn.yml
----------------------------------------------------------------------
diff --git a/docs/_build/config-subpath-brooklyn.yml b/docs/_build/config-subpath-brooklyn.yml
new file mode 100644
index 0000000..ade7e19
--- /dev/null
+++ b/docs/_build/config-subpath-brooklyn.yml
@@ -0,0 +1,9 @@
+# to test for absolute reference problems, prefix each of the paths and set the baseurl
+
+path:
+ style: /brooklyn/style
+ guide: /brooklyn/v/latest
+ website: /brooklyn
+ v: /brooklyn/v
+
+baseurl: /brooklyn
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08068213/docs/_build/config-website-root.yml
----------------------------------------------------------------------
diff --git a/docs/_build/config-website-root.yml b/docs/_build/config-website-root.yml
index 3195f8c..7ac39fe 100644
--- a/docs/_build/config-website-root.yml
+++ b/docs/_build/config-website-root.yml
@@ -1,4 +1,2 @@
-
path:
website: ""
-
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08068213/docs/_config.yml
----------------------------------------------------------------------
diff --git a/docs/_config.yml b/docs/_config.yml
index 8128967..ec8af31 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -31,9 +31,6 @@ path:
guide: /guide
website: /website
v: /v
-# (to test for absolute reference problems you can prefix each of the above,
-# with e.g. /brooklyn , and set the baseurl below)
-#baseurl: /brooklyn
# Use local copies of dependencies in dev build (switched to remote using URLs for prod build)
dependency_mode: local
@@ -43,6 +40,5 @@ dependency_urls:
jquery.js: https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js
# These files should not be included in the final build (in addition to _* contents)
-
-exclude: ['README.md']
+exclude: ['/LICENSE.txt','/README.md']
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08068213/docs/_old/_config.yml
----------------------------------------------------------------------
diff --git a/docs/_old/_config.yml b/docs/_old/_config.yml
deleted file mode 100644
index 9d64146..0000000
--- a/docs/_old/_config.yml
+++ /dev/null
@@ -1,24 +0,0 @@
-#
-# Licensed to the Apache Software Foundation (ASF) under one
-# or more contributor license agreements. See the NOTICE file
-# distributed with this work for additional information
-# regarding copyright ownership. The ASF licenses this file
-# to you under the Apache License, Version 2.0 (the
-# "License"); you may not use this file except in compliance
-# with the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing,
-# software distributed under the License is distributed on an
-# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-# KIND, either express or implied. See the License for the
-# specific language governing permissions and limitations
-# under the License.
-#
-exclude: [ LICENSE.txt, Gemfile, Gemfile.lock ]
-markdown: rdiscount
-brooklyn-version: 0.7.0-SNAPSHOT # BROOKLYN_VERSION
-brooklyn-snapshot-git-branch: master # if line above is SNAPSHOT this should point to corresponding git branch (e.g. master, 0.4)
-brooklyn-root-url: /
-url: /v/0.7.0-SNAPSHOT # BROOKLYN_VERSION
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08068213/docs/_plugins/site_structure.rb
----------------------------------------------------------------------
diff --git a/docs/_plugins/site_structure.rb b/docs/_plugins/site_structure.rb
index 6cfe1f9..95ba1d5 100644
--- a/docs/_plugins/site_structure.rb
+++ b/docs/_plugins/site_structure.rb
@@ -26,6 +26,7 @@ module SiteStructure
end
def generate(site)
+ return nil if site.config['exclude'].index(File.dirname(Pathname.new(SiteStructure::BROOKLYN_WEBSITE_ROOT)))
root_page = find_page_with_path_absolute_or_relative_to(site, SiteStructure::BROOKLYN_WEBSITE_ROOT, nil)
navgroups = root_page.data['navgroups']
navgroups.each do |ng|
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08068213/docs/index.md
----------------------------------------------------------------------
diff --git a/docs/index.md b/docs/index.md
index 021df26..86a0883 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -7,6 +7,7 @@ title: Brooklyn Website and Docs (dev build)
Consider looking at:
-* <a href="website/">the brooklyn website</a>
+* <a href="{{ site.path.website }}/">the brooklyn website</a>
+* <a href="{{ site.path.guide }}/">the brooklyn user guide (version 0.7.0-SNAPSHOT <!-- BROOKLYN_VERSION --></a>
Also see the file <code>README.md</code> in this directory.