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:23:51 UTC
[17/50] [abbrv] incubator-brooklyn git commit: fix paths and links so
that guide/ subdir build works nicely
fix paths and links so that guide/ subdir build works nicely
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/2ac0c6d6
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/2ac0c6d6
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/2ac0c6d6
Branch: refs/heads/master
Commit: 2ac0c6d67eae1eeee6cb34827aaa1fdb1b67f11a
Parents: 2b8a491
Author: Alex Heneveld <al...@cloudsoftcorp.com>
Authored: Mon Dec 15 16:56:12 2014 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
Committed: Wed Dec 17 02:02:55 2014 +0000
----------------------------------------------------------------------
docs/_build/tests/jsonball/toc.json | 2 +-
docs/_config.yml | 13 ++++++--
docs/_includes/breadcrumbs.html | 4 +--
docs/_includes/sidebar.html | 2 +-
docs/_includes/topbar.html | 6 ++--
docs/_layouts/guide-normal.html | 30 +++++++++---------
.../dev/build/debugging-remote-brooklyn.md | 2 +-
docs/guide/dev/build/ide.md | 4 +--
docs/guide/dev/build/index.md | 4 +--
docs/guide/dev/build/tests.md | 2 +-
docs/guide/dev/build/toc.json | 6 ++--
docs/guide/dev/code/entity.md | 6 ++--
docs/guide/dev/code/index.include.md | 14 ++++-----
docs/guide/dev/code/index.md | 2 +-
docs/guide/dev/code/policy.md | 2 +-
docs/guide/dev/code/toc.json | 6 ++--
docs/guide/dev/how-to-contrib.md | 8 ++---
docs/guide/dev/index.md | 2 +-
docs/guide/dev/tips/index.md | 6 ++--
docs/guide/dev/tips/local-artifact-repo.md | 2 +-
docs/guide/dev/tips/logging.md | 2 +-
docs/guide/dev/tips/release.md | 2 +-
docs/guide/dev/tips/standards.md | 2 +-
docs/guide/dev/tips/toc.json | 12 ++++----
docs/guide/dev/tips/update-docs.md | 4 +--
docs/guide/dev/toc.json | 16 +++++-----
docs/guide/index.md | 2 +-
docs/guide/license/index.md | 2 +-
docs/guide/license/license.md | 2 +-
docs/guide/license/toc.json | 2 +-
docs/guide/meta/contact.md | 2 +-
docs/guide/meta/irc.md | 2 +-
docs/guide/meta/toc.json | 6 ++--
docs/guide/meta/verify.md | 2 +-
docs/guide/meta/versions.md | 8 ++---
docs/guide/start/docs-summary.include.md | 8 ++---
docs/guide/start/docs-summary.md | 2 +-
docs/guide/start/download.md | 12 ++++----
docs/guide/start/index.include.md | 16 +++++-----
docs/guide/start/index.md | 2 +-
docs/guide/start/toc.json | 8 ++---
docs/guide/start/walkthrough/index.md | 20 ++++++------
docs/guide/toc-menu.json | 20 ++++++------
docs/guide/toc.json | 20 ++++++------
docs/guide/use/api/index.md | 2 +-
docs/guide/use/contact.md | 2 +-
docs/guide/use/examples/before-begin.include.md | 6 ++--
.../use/examples/global-web-fabric/index.md | 4 +--
docs/guide/use/examples/index.md | 4 +--
docs/guide/use/examples/messaging/index.md | 6 ++--
.../nosql-cassandra/cassandra.include.md | 4 +--
.../guide/use/examples/nosql-cassandra/index.md | 2 +-
docs/guide/use/examples/simple-web-cluster.md | 2 +-
docs/guide/use/examples/toc.json | 10 +++---
docs/guide/use/examples/webcluster.md | 2 +-
docs/guide/use/examples/webcluster/index.md | 2 +-
.../examples/webcluster/webcluster.include.md | 8 ++---
.../defining-applications/advanced-concepts.md | 4 +--
.../defining-applications/basic-concepts.md | 4 +--
.../defining-applications/creating-yaml.md | 20 ++++++------
.../defining-applications/deploying-yaml.md | 2 +-
.../use/guide/defining-applications/toc.json | 18 +++++------
docs/guide/use/guide/entities/index.md | 2 +-
docs/guide/use/guide/entities/toc.json | 12 ++++----
docs/guide/use/guide/extras/toc.json | 10 +++---
docs/guide/use/guide/guide_toc.json | 20 ++++++------
docs/guide/use/guide/management/index.md | 6 ++--
docs/guide/use/guide/management/toc.json | 18 +++++------
docs/guide/use/guide/persistence/toc.json | 16 +++++-----
docs/guide/use/guide/policies/index.md | 6 ++--
docs/guide/use/guide/policies/toc.json | 8 ++---
docs/guide/use/guide/quickstart/index.md | 6 ++--
.../guide/quickstart/policies-and-catalogs.md | 4 +--
docs/guide/use/guide/quickstart/toc.json | 4 +--
docs/guide/use/guide/toc.json | 32 ++++++++++----------
docs/guide/use/index.md | 2 +-
docs/guide/use/toc.json | 12 ++++----
77 files changed, 283 insertions(+), 274 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/_build/tests/jsonball/toc.json
----------------------------------------------------------------------
diff --git a/docs/_build/tests/jsonball/toc.json b/docs/_build/tests/jsonball/toc.json
index 4e129ae..cd01e1a 100644
--- a/docs/_build/tests/jsonball/toc.json
+++ b/docs/_build/tests/jsonball/toc.json
@@ -2,5 +2,5 @@
{ "title": "Test Jsonball",
"file": "test_jsonball.html" },
{ "title": "Home",
- "file": "{{ site.url }}/index.html" }
+ "file": "{{ site.path.guide }}/index.html" }
]
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/_config.yml
----------------------------------------------------------------------
diff --git a/docs/_config.yml b/docs/_config.yml
index a138339..6d18842 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -21,7 +21,16 @@ 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: /
+#@deprecated
+#brooklyn-root-url: /
# url: /v/0.7.0-SNAPSHOT # BROOKLYN_VERSION
-url:
+# url:
+
+url_root: http://0.0.0.0:4000/
+
+path:
+ style: /style
+ guide: /guide
+ v: /v
+
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/_includes/breadcrumbs.html
----------------------------------------------------------------------
diff --git a/docs/_includes/breadcrumbs.html b/docs/_includes/breadcrumbs.html
index 2435326..d3bcbea 100644
--- a/docs/_includes/breadcrumbs.html
+++ b/docs/_includes/breadcrumbs.html
@@ -26,7 +26,7 @@ under the License.
{% capture toc_string %}{% readj p %}{% endcapture %}
{% jsonball toc from var toc_string %}
-{% capture pagesiteurl %}{{ site.url }}{{ page.url }}{% endcapture %}
+{% capture pagesiteurl %}{{ page.url }}{% endcapture %}
{% for x in toc %}
{% if pagesiteurl == x.file %}
@@ -55,7 +55,7 @@ under the License.
{% if l1name %}{% else %}
{% capture l1name %}Home{% endcapture %}
- {% capture l1link %}{{ site.url }}{% endcapture %}
+ {% capture l1link %}{{ site.todo_page }}{% endcapture %}
{% capture l2name %}{{ page.title }}{% endcapture %}
{% capture l2link %}{{ pagesiteurl }}{% endcapture %}
{% endif %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/_includes/sidebar.html
----------------------------------------------------------------------
diff --git a/docs/_includes/sidebar.html b/docs/_includes/sidebar.html
index aea5e8e..cea3ba4 100644
--- a/docs/_includes/sidebar.html
+++ b/docs/_includes/sidebar.html
@@ -27,7 +27,7 @@ under the License.
{% capture toc_string %}{% readj p %}{% endcapture %}
{% jsonball toc from var toc_string %}
-{% capture pagesiteurl %}{{ site.url }}{{ page.url }}{% endcapture %}
+{% capture pagesiteurl %}{{ page.url }}{% endcapture %}
<div id="sidebar_toc">
{% for x in toc %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/_includes/topbar.html
----------------------------------------------------------------------
diff --git a/docs/_includes/topbar.html b/docs/_includes/topbar.html
index c865925..3c3cb7d 100644
--- a/docs/_includes/topbar.html
+++ b/docs/_includes/topbar.html
@@ -18,11 +18,11 @@ specific language governing permissions and limitations
under the License.
-->
-{% assign p = '/toc-menu.json' %}
+{% assign p = '/guide/toc-menu.json' %}
{% capture tocm_string %}{% readj p %}{% endcapture %}
{% jsonball tocm from var tocm_string %}
-{% capture pagesiteurl %}{{ site.url }}{{ page.url }}{% endcapture %}
+{% capture pagesiteurl %}{{ page.url }}{% endcapture %}
<ul id="mainmenu"><!-- INSERT LINKS -->
@@ -46,4 +46,4 @@ under the License.
<li class="{{ifactive}}"><a href="{{ x.file }}">{{x.title}}</a></li>
{% endfor %}
-</ul>
\ No newline at end of file
+</ul>
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/_layouts/guide-normal.html
----------------------------------------------------------------------
diff --git a/docs/_layouts/guide-normal.html b/docs/_layouts/guide-normal.html
index fcb8f7e..37dba39 100644
--- a/docs/_layouts/guide-normal.html
+++ b/docs/_layouts/guide-normal.html
@@ -25,19 +25,19 @@ under the License.
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
<title>{{ page.title }}</title>
- <link rel="stylesheet" href="{{ site.url }}/style/css/guide.css" type="text/css" media="screen" />
- <link rel="stylesheet" href="{{ site.url }}/style/css/guide-toc.css" type="text/css" media="screen" />
- <link rel="stylesheet" href="{{ site.url }}/style/css/code.css" type="text/css" media="screen" />
+ <link rel="stylesheet" href="{{ site.path.style }}/css/guide.css" type="text/css" media="screen" />
+ <link rel="stylesheet" href="{{ site.path.style }}/css/guide-toc.css" type="text/css" media="screen" />
+ <link rel="stylesheet" href="{{ site.path.style }}/css/code.css" type="text/css" media="screen" />
<script type="text/javascript" src="https://www.google.com/jsapi"></script>
<!-- Sidebar/ToC Scripts and CSS -->
- <script src="{{ site.url }}/style/deps/jquery.js"></script>
- <script src="{{ site.url }}/style/deps/jquery-ui/jquery-ui-1.8.18.custom.min.js"></script>
- <link rel="stylesheet" type="text/css" href="{{ site.url }}/style/deps/jquery-ui/jquery-ui-1.8.18.custom.css" />
+ <script src="{{ site.path.style }}/deps/jquery.js"></script>
+ <script src="{{ site.path.style }}/deps/jquery-ui/jquery-ui-1.8.18.custom.min.js"></script>
+ <link rel="stylesheet" type="text/css" href="{{ site.path.style }}/deps/jquery-ui/jquery-ui-1.8.18.custom.css" />
- <script type="text/javascript" src="{{ site.url }}/style/deps/superfish.js"></script>
- <script type="text/javascript" src="{{ site.url }}/style/deps/jquery.cookie.js"></script>
+ <script type="text/javascript" src="{{ site.path.style }}/deps/superfish.js"></script>
+ <script type="text/javascript" src="{{ site.path.style }}/deps/jquery.cookie.js"></script>
<!-- Clipboard support -->
@@ -45,12 +45,12 @@ under the License.
<style type="text/css">
.clipboard_container { float: right; padding: 8px; }
.clipboard_button {
- background-image: url("{{ site.url }}/style/img/clipboard-green-normal.png");
+ background-image: url("{{ site.path.style }}/img/clipboard-green-normal.png");
background-size: 18px 21px;
width: 18px; height: 21px;
}
-.clipboard_button:hover, .clipboard_button.zeroclipboard-is-hover { background-image: url("{{ site.url }}/style/img/clipboard-green-hover.png"); }
-.clipboard_button:active, .clipboard_button.zeroclipboard-is-active { background-image: url("{{ site.url }}/style/img/clipboard-green-click.png"); }'
+.clipboard_button:hover, .clipboard_button.zeroclipboard-is-hover { background-image: url("{{ site.path.style }}/img/clipboard-green-hover.png"); }
+.clipboard_button:active, .clipboard_button.zeroclipboard-is-active { background-image: url("{{ site.path.style }}/img/clipboard-green-click.png"); }'
</style>
<script type="text/javascript"> <!-- clipboard -->
ZeroClipboard.config({ moviePath: '//cdnjs.cloudflare.com/ajax/libs/zeroclipboard/1.3.1/ZeroClipboard.swf' });
@@ -123,7 +123,7 @@ console.log("setting text to "+txt);
if (!$.cookie('brooklyn_versions') ||
(($.inArray('ALL', $.cookie('brooklyn_versions').split(",")) === -1) &&
($.inArray(thisversion, $.cookie('brooklyn_versions').split(",")) === -1)) ){
- msg += "<div class='warning_banner_image'><img src='{{ site.url }}/style/img/warning.png'/></div>";
+ msg += "<div class='warning_banner_image'><img src='{{ site.path.style }}/img/warning.png'/></div>";
msg += "<p>This content is for <strong>Brooklyn "+thisversion+"</strong>, and may differ across versions.</p>";
msg += "<p>Are you using version "+thisversion+"?</p>";
msg += "<p class='warning_banner_buttons'>";
@@ -191,11 +191,11 @@ console.log("setting text to "+txt);
</div>
<ul id="quicklinks">
- <li><a href="{{site.url}}/meta/versions.html">{{ site.brooklyn-version }}</a></li>
- <li><a href="{{site.url}}/start/download.html">Download</a></li>
+ <li><a href="{{site.path.guide}}/meta/versions.html">{{ site.brooklyn-version }}</a></li>
+ <li><a href="{{site.path.guide}}/start/download.html">Download</a></li>
<li><a href="https://github.com/brooklyncentral">GitHub</a></li>
<li><a href="https://twitter.com/#!/search?q=brooklyncentral">Twitter</a></li>
- <li><a href="{{site.url}}/meta/contact.html">Contact</a></li>
+ <li><a href="{{site.path.guide}}/meta/contact.html">Contact</a></li>
</ul>
<div id="menubar">
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/dev/build/debugging-remote-brooklyn.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/build/debugging-remote-brooklyn.md b/docs/guide/dev/build/debugging-remote-brooklyn.md
index d924804..337aa21 100644
--- a/docs/guide/dev/build/debugging-remote-brooklyn.md
+++ b/docs/guide/dev/build/debugging-remote-brooklyn.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Brooklyn Remote Debugging
-toc: /toc.json
+toc: /guide/toc.json
---
Usually during development, you will be running Brooklyn from your IDE (see [IDE Setup](ide.html)), in which case
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/dev/build/ide.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/build/ide.md b/docs/guide/dev/build/ide.md
index bdc7478..3abae3c 100644
--- a/docs/guide/dev/build/ide.md
+++ b/docs/guide/dev/build/ide.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: IDE Setup
-toc: /toc.json
+toc: /guide/toc.json
---
Gone are the days when IDE integration always just works... Maven and Eclipse fight,
@@ -77,7 +77,7 @@ find . \( -path "*/src/main" -or -path "*/src/test" \) -exec echo {} \; -exec mk
or edit the ``.project`` manually adding it to the project properties).
The tips [for jclouds maven-eclipse](http://www.jclouds.org/documentation/devguides/using-eclipse) might be helpful.
-If the pain starts to be too much, come find us on IRC #brooklyncentral or [elsewhere]({{site.url}}/meta/contact.html) and we can hopefully share our pearls.
+If the pain starts to be too much, come find us on IRC #brooklyncentral or [elsewhere]({{site.path.guide}}/meta/contact.html) and we can hopefully share our pearls.
(And if you have a tip we haven't mentioned please let us know that too!)
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/dev/build/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/build/index.md b/docs/guide/dev/build/index.md
index 7dd3412..53b95f6 100644
--- a/docs/guide/dev/build/index.md
+++ b/docs/guide/dev/build/index.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Maven Build
-toc: /toc.json
+toc: /guide/toc.json
---
## The Basics
@@ -74,7 +74,7 @@ If there is a good reason that a file, pattern, or directory should be permanent
* The **developers catalog** ([developers-catalog.xml](developers-catalog.xml)) uses artifacts from your local `~/.m2/repository/...` (after building from source). This avoids unnecessary web requests to Maven Central or Sonatype, and will allow you to work off-line.
- ``wget {{site.url}}/dev/build/developers-catalog.xml > ~/.brooklyn/catalog.xml``
+ ``wget {{site.path.guide}}/dev/build/developers-catalog.xml > ~/.brooklyn/catalog.xml``
## Appendix: Sample Output
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/dev/build/tests.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/build/tests.md b/docs/guide/dev/build/tests.md
index 16f6810..f202dc2 100644
--- a/docs/guide/dev/build/tests.md
+++ b/docs/guide/dev/build/tests.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Tests
-toc: /toc.json
+toc: /guide/toc.json
---
We have the following tests groups:
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/dev/build/toc.json
----------------------------------------------------------------------
diff --git a/docs/guide/dev/build/toc.json b/docs/guide/dev/build/toc.json
index fca9b70..192f1e3 100644
--- a/docs/guide/dev/build/toc.json
+++ b/docs/guide/dev/build/toc.json
@@ -1,8 +1,8 @@
[
{ "title": "Maven",
- "file": "{{ site.url }}/dev/build/index.html" },
+ "file": "{{ site.path.guide }}/dev/build/index.html" },
{ "title": "IDE",
- "file": "{{ site.url }}/dev/build/ide.html" },
+ "file": "{{ site.path.guide }}/dev/build/ide.html" },
{ "title": "Tests",
- "file": "{{ site.url }}/dev/build/tests.html" }
+ "file": "{{ site.path.guide }}/dev/build/tests.html" }
]
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/dev/code/entity.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/code/entity.md b/docs/guide/dev/code/entity.md
index 7001612..f84e23c 100644
--- a/docs/guide/dev/code/entity.md
+++ b/docs/guide/dev/code/entity.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Writing an Entity
-toc: /toc.json
+toc: /guide/toc.json
---
## Ways to write an entity
@@ -86,6 +86,6 @@ hierarchy; it is suggested to avoid these, looking at the ones below instead):
You might also find the following helpful:
-* **[Entity Design Tips]({{site.url}}/dev/tips/index.html#EntityDesign)**
-* The **[User Guide]({{site.url}}/use/guide/index.html)**
+* **[Entity Design Tips]({{site.path.guide}}/dev/tips/index.html#EntityDesign)**
+* The **[User Guide]({{site.path.guide}}/use/guide/index.html)**
* The **[Mailing List](https://mail-archives.apache.org/mod_mbox/incubator-brooklyn-dev/)**
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/dev/code/index.include.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/code/index.include.md b/docs/guide/dev/code/index.include.md
index a213cd6..ab7f7ec 100644
--- a/docs/guide/dev/code/index.include.md
+++ b/docs/guide/dev/code/index.include.md
@@ -21,12 +21,12 @@ bin/brooklyn launch
{% endhighlight %}
Plenty of examples are in the **examples** sub-dir,
-described [here]({{site.url}}/use/examples),
+described [here]({{site.path.guide}}/use/examples),
and pushed to the [brooklyn-examples](http://github.com/brooklyncentral/brooklyn-examples)
GitHub project when a version is released.
Information on using Brooklyn -- configuring locations (in `brooklyn.properties`)
-and adding new projects to a catalog -- can be found in the [User's Guide]({{site.url}}/use/guide/quickstart/index.html).
+and adding new projects to a catalog -- can be found in the [User's Guide]({{site.path.guide}}/use/guide/quickstart/index.html).
This document is intended to help people become familiar with the codebase.
## Project Structure
@@ -71,8 +71,8 @@ Brooklyn is split into the following projects and sub-projects:
* **scripts**: various scripts useful for building, updating, etc. (see comments in the scripts)
* **qa**: longevity and stress tests
* **test-support**: provides Brooklyn-specific support for tests, used by nearly all projects in scope ``test``
-* **``docs``**: the markdown source code for this documentation, as described [here]({{site.url}}/dev/tips/update-docs.html)
-* **``examples``**: some canonical examples, as listed [here]({{site.url}}/use/examples)
+* **``docs``**: the markdown source code for this documentation, as described [here]({{site.path.guide}}/dev/tips/update-docs.html)
+* **``examples``**: some canonical examples, as listed [here]({{site.path.guide}}/use/examples)
* **``sandbox``**: various projects, entities, and policies which the Brooklyn Project is incubating
@@ -90,9 +90,9 @@ If you want to start writing your own policies and entities, have a look at:
* [Writing a Brooklyn Entity](entity.html)
* [Writing a Brooklyn Policy](policy.html)
-* Or see the [User Guide]({{ site.url }}/use/guide/index.html)
- on [policies]({{ site.url }}/use/guide/policies/index.html)
- and [entities]({{ site.url }}/use/guide/entities/index.html)
+* Or see the [User Guide]({{ site.path.guide }}/use/guide/index.html)
+ on [policies]({{ site.path.guide }}/use/guide/policies/index.html)
+ and [entities]({{ site.path.guide }}/use/guide/entities/index.html)
Where things aren't documented **please ask us** at
[the brooklyn mailing list](https://mail-archives.apache.org/mod_mbox/incubator-brooklyn-dev/)
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/dev/code/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/code/index.md b/docs/guide/dev/code/index.md
index ecf9fcf..8220a8d 100644
--- a/docs/guide/dev/code/index.md
+++ b/docs/guide/dev/code/index.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Code Structure
-toc: /toc.json
+toc: /guide/toc.json
---
{% readj index.include.md %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/dev/code/policy.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/code/policy.md b/docs/guide/dev/code/policy.md
index 7bbbcad..a62bdd2 100644
--- a/docs/guide/dev/code/policy.md
+++ b/docs/guide/dev/code/policy.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Writing a Policy
-toc: /toc.json
+toc: /guide/toc.json
---
Policies perform the active management enabled by Brooklyn.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/dev/code/toc.json
----------------------------------------------------------------------
diff --git a/docs/guide/dev/code/toc.json b/docs/guide/dev/code/toc.json
index d599dbe..144ea26 100644
--- a/docs/guide/dev/code/toc.json
+++ b/docs/guide/dev/code/toc.json
@@ -1,10 +1,10 @@
[
{ "title": "Structure",
- "file": "{{ site.url }}/dev/code/index.html" },
+ "file": "{{ site.path.guide }}/dev/code/index.html" },
{ "title": "Writing an Entity",
- "file": "{{ site.url }}/dev/code/entity.html" },
+ "file": "{{ site.path.guide }}/dev/code/entity.html" },
{ "title": "Writing a Policy",
- "file": "{{ site.url }}/dev/code/policy.html" },
+ "file": "{{ site.path.guide }}/dev/code/policy.html" },
{ "title": "brooklyn.git (github)",
"file": "http://github.com/brooklyncentral/brooklyn" }
]
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/dev/how-to-contrib.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/how-to-contrib.md b/docs/guide/dev/how-to-contrib.md
index b5a8306..120d3d9 100644
--- a/docs/guide/dev/how-to-contrib.md
+++ b/docs/guide/dev/how-to-contrib.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: How to Contribute
-toc: /toc.json
+toc: /guide/toc.json
---
### The Process
@@ -23,7 +23,7 @@ it's easy to give back to the community. Just:
1. **Issue a pull request** from your GitHub repo
The same process holds for contributing to this documentation (web site and user guide),
-but see the additional [tips for updating documentation]({{ site.url }}/dev/tips/update-docs.html).
+but see the additional [tips for updating documentation]({{ site.path.guide }}/dev/tips/update-docs.html).
### Some Words of Advice
@@ -33,6 +33,6 @@ but see the additional [tips for updating documentation]({{ site.url }}/dev/tips
* Include javadoc and tests
-* See the [tips here]({{site.url}}/dev/tips/index.html)
+* See the [tips here]({{site.path.guide}}/dev/tips/index.html)
-* If you get blocked, **[hollar]({{site.url}}/meta/contact.html)**!
+* If you get blocked, **[hollar]({{site.path.guide}}/meta/contact.html)**!
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/dev/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/index.md b/docs/guide/dev/index.md
index 11377d7..c6c9e33 100644
--- a/docs/guide/dev/index.md
+++ b/docs/guide/dev/index.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Getting to Code
-toc: /toc.json
+toc: /guide/toc.json
---
{% readj code/index.include.md %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/dev/tips/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/tips/index.md b/docs/guide/dev/tips/index.md
index 664a95e..e809b7d 100644
--- a/docs/guide/dev/tips/index.md
+++ b/docs/guide/dev/tips/index.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Miscellaneous Tips and Tricks
-toc: /toc.json
+toc: /guide/toc.json
---
## General Good Ways of Working
@@ -13,7 +13,7 @@ toc: /toc.json
* When debugging an entity, make sure the [brooklyn.SSH logger](logging.html) is set to DEBUG and accessible.
-* Use tests heavily! These are pretty good to run in the IDE (once you've completed [IDE setup]({{site.url}}/dev/build/ide.html)),
+* Use tests heavily! These are pretty good to run in the IDE (once you've completed [IDE setup]({{site.path.guide}}/dev/build/ide.html)),
and far quicker to spot problems than runtime, plus we get early-warning of problems introduced in the future.
(In particular, Groovy's laxity with compilation means it is easy to introduce silly errors which good test coverage will find much faster.)
@@ -37,7 +37,7 @@ toc: /toc.json
Clusters will take such a ``MachineProvisioningLocation`` (or a singleton list); fabircs take a list of locations.
Some PaaS systems have their own location model, such as ``OpenShiftLocation``.
-Finally, don't be shy about [talking with others]({{site.url}}/meta/contact.html),
+Finally, don't be shy about [talking with others]({{site.path.guide}}/meta/contact.html),
that's far better than spinning your wheels (or worse, having a bad experience),
plus it means we can hopefully improve things for other people!
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/dev/tips/local-artifact-repo.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/tips/local-artifact-repo.md b/docs/guide/dev/tips/local-artifact-repo.md
index a96c62f..455a545 100644
--- a/docs/guide/dev/tips/local-artifact-repo.md
+++ b/docs/guide/dev/tips/local-artifact-repo.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Prepopulating a Local Artifact Repository
-toc: /toc.json
+toc: /guide/toc.json
---
On occasion it can be useful to have/control/prepopulate a local repository of entity installers <small>[1]</small>.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/dev/tips/logging.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/tips/logging.md b/docs/guide/dev/tips/logging.md
index 4e6b001..d639762 100644
--- a/docs/guide/dev/tips/logging.md
+++ b/docs/guide/dev/tips/logging.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Logging
-toc: /toc.json
+toc: /guide/toc.json
---
## Logging: A Quick Overview
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/dev/tips/release.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/tips/release.md b/docs/guide/dev/tips/release.md
index 35c5904..f56f81e 100644
--- a/docs/guide/dev/tips/release.md
+++ b/docs/guide/dev/tips/release.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Release Process
-toc: /toc.json
+toc: /guide/toc.json
---
<!--
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/dev/tips/standards.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/tips/standards.md b/docs/guide/dev/tips/standards.md
index 259ab20..66b77b0 100644
--- a/docs/guide/dev/tips/standards.md
+++ b/docs/guide/dev/tips/standards.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Code Standards
-toc: /toc.json
+toc: /guide/toc.json
---
Without being too restrictive about how you have to code as part of Brooklyn,
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/dev/tips/toc.json
----------------------------------------------------------------------
diff --git a/docs/guide/dev/tips/toc.json b/docs/guide/dev/tips/toc.json
index 0be0aba..43fddac 100644
--- a/docs/guide/dev/tips/toc.json
+++ b/docs/guide/dev/tips/toc.json
@@ -1,14 +1,14 @@
[
{ "title": "Miscellany",
- "file": "{{ site.url }}/dev/tips/index.html" },
+ "file": "{{ site.path.guide }}/dev/tips/index.html" },
{ "title": "Logging",
- "file": "{{ site.url }}/dev/tips/logging.html" },
+ "file": "{{ site.path.guide }}/dev/tips/logging.html" },
{ "title": "Code Standards",
- "file": "{{ site.url }}/dev/tips/standards.html" },
+ "file": "{{ site.path.guide }}/dev/tips/standards.html" },
{ "title": "Local Artifact Repo",
- "file": "{{ site.url }}/dev/tips/local-artifact-repo.html" },
+ "file": "{{ site.path.guide }}/dev/tips/local-artifact-repo.html" },
{ "title": "Updating Docs",
- "file": "{{ site.url }}/dev/tips/update-docs.html" },
+ "file": "{{ site.path.guide }}/dev/tips/update-docs.html" },
{ "title": "Release Process",
- "file": "{{ site.url }}/dev/tips/release.html" }
+ "file": "{{ site.path.guide }}/dev/tips/release.html" }
]
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/dev/tips/update-docs.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/tips/update-docs.md b/docs/guide/dev/tips/update-docs.md
index 5d72e47..0f2aafb 100644
--- a/docs/guide/dev/tips/update-docs.md
+++ b/docs/guide/dev/tips/update-docs.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Updating the Docs
-toc: /toc.json
+toc: /guide/toc.json
---
The Brooklyn docs live in the **docs** project in the Brooklyn codebase.
@@ -65,6 +65,6 @@ for convenience.
The latest stable version typically lives in the root of the `brooklyncentral.github.com` project.
Archived versions are kept under `/v/*` with logic in the markdown for
-[meta/versions]({{ site.url }}/meta/versions.html) to link to related versions.
+[meta/versions]({{ site.path.guide }}/meta/versions.html) to link to related versions.
Additional instructions and scripts for automating the installs can be found in `/docs/_scripts/`.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/dev/toc.json
----------------------------------------------------------------------
diff --git a/docs/guide/dev/toc.json b/docs/guide/dev/toc.json
index f22e840..53c9612 100644
--- a/docs/guide/dev/toc.json
+++ b/docs/guide/dev/toc.json
@@ -1,18 +1,18 @@
[
{ "title": "The Code",
- "file": "{{ site.url }}/dev/code/index.html",
+ "file": "{{ site.path.guide }}/dev/code/index.html",
"exclude": true,
- "children": {% readj ./code/toc.json %} },
+ "children": {% readj code/toc.json %} },
{ "title": "Build and Test",
- "file": "{{ site.url }}/dev/build/index.html",
+ "file": "{{ site.path.guide }}/dev/build/index.html",
"exclude": true,
- "children": {% readj ./build/toc.json %} },
+ "children": {% readj build/toc.json %} },
{ "title": "Tips and Tricks",
- "file": "{{ site.url }}/dev/tips/index.html",
+ "file": "{{ site.path.guide }}/dev/tips/index.html",
"exclude": true,
- "children": {% readj ./tips/toc.json %} },
+ "children": {% readj tips/toc.json %} },
{ "title": "Links",
- "file": "{{ site.url }}/dev/links.html",
+ "file": "{{ site.path.guide }}/dev/links.html",
"children": [
{ "title": "Github repo",
"file": "https://github.com/brooklyncentral/" },
@@ -22,5 +22,5 @@
"file": "http://ccweb.cloudsoftcorp.com/maven/libs-snapshot-local/io/brooklyn/" }
] },
{ "title": "How to Contribute",
- "file": "{{ site.url }}/dev/how-to-contrib.html" }
+ "file": "{{ site.path.guide }}/dev/how-to-contrib.html" }
]
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/index.md b/docs/guide/index.md
index 8665cdf..41624d0 100644
--- a/docs/guide/index.md
+++ b/docs/guide/index.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Overview
-toc: /toc.json
+toc: /guide/toc.json
categories: [start]
---
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/license/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/license/index.md b/docs/guide/license/index.md
index aed028d..af33ed0 100644
--- a/docs/guide/license/index.md
+++ b/docs/guide/license/index.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Brooklyn Licenses
-toc: /toc.json
+toc: /guide/toc.json
---
## License
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/license/license.md
----------------------------------------------------------------------
diff --git a/docs/guide/license/license.md b/docs/guide/license/license.md
index 75cceac..6fe8339 100644
--- a/docs/guide/license/license.md
+++ b/docs/guide/license/license.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: License
-toc: /toc.json
+toc: /guide/toc.json
---
Brooklyn is licensed to the public as open source under the
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/license/toc.json
----------------------------------------------------------------------
diff --git a/docs/guide/license/toc.json b/docs/guide/license/toc.json
index 8194f80..384d368 100644
--- a/docs/guide/license/toc.json
+++ b/docs/guide/license/toc.json
@@ -1,4 +1,4 @@
[
{ "title": "Apache License v2.0",
- "file": "{{ site.url }}/license/license.html" }
+ "file": "{{ site.path.guide }}/license/license.html" }
]
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/meta/contact.md
----------------------------------------------------------------------
diff --git a/docs/guide/meta/contact.md b/docs/guide/meta/contact.md
index 937e763..c318a1f 100644
--- a/docs/guide/meta/contact.md
+++ b/docs/guide/meta/contact.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Contact
-toc: /toc.json
+toc: /guide/toc.json
---
{% readj contact.include.md %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/meta/irc.md
----------------------------------------------------------------------
diff --git a/docs/guide/meta/irc.md b/docs/guide/meta/irc.md
index 5827818..9324bd2 100644
--- a/docs/guide/meta/irc.md
+++ b/docs/guide/meta/irc.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: IRC
-toc: /toc.json
+toc: /guide/toc.json
---
IRC is a basic group chat system used by many open source projects to enable developers to
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/meta/toc.json
----------------------------------------------------------------------
diff --git a/docs/guide/meta/toc.json b/docs/guide/meta/toc.json
index 694eaea..f01fa8e 100644
--- a/docs/guide/meta/toc.json
+++ b/docs/guide/meta/toc.json
@@ -1,8 +1,8 @@
[
{ "title": "Versions",
- "file": "{{ site.url }}/meta/versions.html" },
+ "file": "{{ site.path.guide }}/meta/versions.html" },
{ "title": "Verify",
- "file": "{{ site.url }}/meta/verify.html" },
+ "file": "{{ site.path.guide }}/meta/verify.html" },
{ "title": "Contact",
- "file": "{{ site.url }}/meta/contact.html" }
+ "file": "{{ site.path.guide }}/meta/contact.html" }
]
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/meta/verify.md
----------------------------------------------------------------------
diff --git a/docs/guide/meta/verify.md b/docs/guide/meta/verify.md
index 889e5bd..74037fa 100644
--- a/docs/guide/meta/verify.md
+++ b/docs/guide/meta/verify.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Verify the Integrity of Downloads
-toc: /toc.json
+toc: /guide/toc.json
---
{% include fields.md %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/meta/versions.md
----------------------------------------------------------------------
diff --git a/docs/guide/meta/versions.md b/docs/guide/meta/versions.md
index 53a6a0d..9466473 100644
--- a/docs/guide/meta/versions.md
+++ b/docs/guide/meta/versions.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Versions
-toc: /toc.json
+toc: /guide/toc.json
---
<!--- display which version we are using, based on where it is written -->
@@ -22,7 +22,7 @@ Files must be copied to the brooklyncentral.github.com repo for these links to r
{% if site.brooklyn-version contains 'SNAPSHOT' %}
<!--- snapshot version -->
- {% if site.url == '' %}
+ {% if site.path.guide == '' %}
<!--- current version (served off root of site) is snapshot (unusual) -->
@@ -50,7 +50,7 @@ rather than a shapshot.
{% else %}
<!--- not snapshot -->
- {% if site.url == '' %}
+ {% if site.path.guide == '' %}
<!--- current version (served off root of site) -->
@@ -63,7 +63,7 @@ Other versions with documentation available are listed below.
<!--- archive version -->
This is the archived documentation for Brooklyn {{ site.brooklyn-version }}
-(generated {{ site.time }}, archived under {{ site.url }}).
+(generated {{ site.time }}, archived under {{ site.path.guide }}).
[View current documentation here.](/meta/versions.html)
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/start/docs-summary.include.md
----------------------------------------------------------------------
diff --git a/docs/guide/start/docs-summary.include.md b/docs/guide/start/docs-summary.include.md
index c08c06f..9dac44d 100644
--- a/docs/guide/start/docs-summary.include.md
+++ b/docs/guide/start/docs-summary.include.md
@@ -1,7 +1,7 @@
To learn about Brooklyn, here are some recommended starting points:
-* [Developer's Walkthrough]({{site.url}}/start/walkthrough/index.html)
-* [Examples]({{site.url}}/use/examples/)
-* [User Guide]({{site.url}}/use/guide/)
-* [Code Overview]({{site.url}}/dev/code/)
+* [Developer's Walkthrough]({{site.path.guide}}/start/walkthrough/index.html)
+* [Examples]({{site.path.guide}}/use/examples/)
+* [User Guide]({{site.path.guide}}/use/guide/)
+* [Code Overview]({{site.path.guide}}/dev/code/)
* [Code on Github](http://github.com/brooklyncentral/brooklyn/)
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/start/docs-summary.md
----------------------------------------------------------------------
diff --git a/docs/guide/start/docs-summary.md b/docs/guide/start/docs-summary.md
index 4e993fa..25ba02b 100644
--- a/docs/guide/start/docs-summary.md
+++ b/docs/guide/start/docs-summary.md
@@ -6,4 +6,4 @@ toc: ../toc.json
{% readj docs-summary.include.md %}
-Beyond this, [just come chat to us]({{site.url}}/meta/contact.html).
+Beyond this, [just come chat to us]({{site.path.guide}}/meta/contact.html).
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/start/download.md
----------------------------------------------------------------------
diff --git a/docs/guide/start/download.md b/docs/guide/start/download.md
index 0e82a84..20f7261 100644
--- a/docs/guide/start/download.md
+++ b/docs/guide/start/download.md
@@ -5,7 +5,7 @@ toc: ../toc.json
---
{% include fields.md %}
-First time user? The [getting started]({{ site.url }}/use/guide/quickstart/index.html) guide will walk you through downloading Brooklyn, setup of your `brooklyn.properties` and `catalog.xml` files, and then trying the [examples](#examples).
+First time user? The [getting started]({{ site.path.guide }}/use/guide/quickstart/index.html) guide will walk you through downloading Brooklyn, setup of your `brooklyn.properties` and `catalog.xml` files, and then trying the [examples](#examples).
## Download Version {{ site.brooklyn-version }}
@@ -31,7 +31,7 @@ First time user? The [getting started]({{ site.url }}/use/guide/quickstart/index
</tr>
<tr>
<td style='text-align:left'>Release notes</td>
- <td style='text-align:left'><a href='{{ site.url }}/start/release-notes.html'>{{ site.brooklyn-version }}</a></td>
+ <td style='text-align:left'><a href='{{ site.path.guide }}/start/release-notes.html'>{{ site.brooklyn-version }}</a></td>
<td> - </td>
</tr>
</table>
@@ -72,7 +72,7 @@ This is a single JAR containing all of Brooklyn and its dependencies, for develo
## Release Notes
-Release notes can be found [here]({{ site.url }}/start/release-notes.html).
+Release notes can be found [here]({{ site.path.guide }}/start/release-notes.html).
<a name="examples"></a>
## Examples
@@ -86,7 +86,7 @@ When this version is released, the [brooklyn-examples git repository](http://git
You can checkout the examples from the [brooklyn-examples git repository](http://github.com/brooklyncentral/brooklyn-examples).
-Maven (v3) is required to build them, as described [here]({{ site.url }}/dev/build/).
+Maven (v3) is required to build them, as described [here]({{ site.path.guide }}/dev/build/).
The examples for this version ({{ site.brooklyn-version }}) are in the branch
`{% if SNAPSHOT %}{{ site.brooklyn-snapshot-git-branch }}{% else %}{{ site.brooklyn-version }}{% endif %}`, so if you have `git` and `mvn` already, you can simply:
@@ -112,7 +112,7 @@ These commands should do the trick:
{% endhighlight %}
-A good example to start with is the [Elastic Web Cluster]({{site.url}}/use/examples/webcluster.html).
+A good example to start with is the [Elastic Web Cluster]({{site.path.guide}}/use/examples/webcluster.html).
{% endif %}
@@ -176,7 +176,7 @@ or one of the additional snapshot repositories above.
## Source Code
Full source is at [github.com/brooklyncentral/brooklyn](http://github.com/brooklyncentral/brooklyn).
-Information on working with the source is [here]({{ site.url }}/dev/code).
+Information on working with the source is [here]({{ site.path.guide }}/dev/code).
Alternatively you can download archives of the source directly:
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/start/index.include.md
----------------------------------------------------------------------
diff --git a/docs/guide/start/index.include.md b/docs/guide/start/index.include.md
index 1406337..0412ec9 100644
--- a/docs/guide/start/index.include.md
+++ b/docs/guide/start/index.include.md
@@ -33,18 +33,18 @@ open-sourced here and giving you full control over what you want to happen.
More importantly, however, this code can be shared, improved, and extended.
We're still near the beginning of figuring this out:
-[join us to make it better]({{site.url}}/meta/contact.html).
+[join us to make it better]({{site.path.guide}}/meta/contact.html).
## To Get Started
-* See the [developer's walkthrough]({{site.url}}/start/walkthrough/index.html) for a quick tour
-* Check out the [examples]({{site.url}}/use/examples/), from a global web fabric with geo-DNS to a movable PaaS target
-* Jump in to the [user guide]({{site.url}}/use/guide/) describing the
- [concepts]({{site.url}}/use/guide/defining-applications/basic-concepts.html)
- and including a [tutorial]({{site.url}}/use/guide/quickstart/)
-* Or dive straight in to the code, either [reading]({{site.url}}/dev/code/) about it
+* See the [developer's walkthrough]({{site.path.guide}}/start/walkthrough/index.html) for a quick tour
+* Check out the [examples]({{site.path.guide}}/use/examples/), from a global web fabric with geo-DNS to a movable PaaS target
+* Jump in to the [user guide]({{site.path.guide}}/use/guide/) describing the
+ [concepts]({{site.path.guide}}/use/guide/defining-applications/basic-concepts.html)
+ and including a [tutorial]({{site.path.guide}}/use/guide/quickstart/)
+* Or dive straight in to the code, either [reading]({{site.path.guide}}/dev/code/) about it
or [gitting](http://github.com/brooklyncentral/brooklyn/) it
If you like it, or if you have ideas how it could be better,
-[join the discussion]({{site.url}}/meta/contact.html).
+[join the discussion]({{site.path.guide}}/meta/contact.html).
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/start/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/start/index.md b/docs/guide/start/index.md
index b3e9983..eda9390 100644
--- a/docs/guide/start/index.md
+++ b/docs/guide/start/index.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Overview
-toc: /toc.json
+toc: /guide/toc.json
categories: [start]
---
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/start/toc.json
----------------------------------------------------------------------
diff --git a/docs/guide/start/toc.json b/docs/guide/start/toc.json
index 43d79d7..532ce68 100644
--- a/docs/guide/start/toc.json
+++ b/docs/guide/start/toc.json
@@ -1,10 +1,10 @@
[
{ "title": "Overview",
- "file": "{{ site.url }}/index.html" },
+ "file": "{{ site.path.guide }}/index.html" },
{ "title": "Walkthrough",
- "file": "{{ site.url }}/start/walkthrough/index.html" },
+ "file": "{{ site.path.guide }}/start/walkthrough/index.html" },
{ "title": "Download",
- "file": "{{ site.url }}/start/download.html" },
+ "file": "{{ site.path.guide }}/start/download.html" },
{ "title": "Documentation",
- "file": "{{ site.url }}/start/docs-summary.html" }
+ "file": "{{ site.path.guide }}/start/docs-summary.html" }
]
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/start/walkthrough/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/start/walkthrough/index.md b/docs/guide/start/walkthrough/index.md
index de29f5c..d68aad4 100644
--- a/docs/guide/start/walkthrough/index.md
+++ b/docs/guide/start/walkthrough/index.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Walkthrough
-toc: /toc.json
+toc: /guide/toc.json
---
{% include fields.md %}
@@ -44,7 +44,7 @@ $ cd brooklyn-sample
{% endhighlight %}
*Note*: As this is a snapshot version of Brooklyn, the code above includes a `-DarchetypeCatalog` specification.
-This can be omitted for release versions, or if you already have a local `mvn install` of Brooklyn installed as described [here]({{site.url}}/dev/code/index.html).
+This can be omitted for release versions, or if you already have a local `mvn install` of Brooklyn installed as described [here]({{site.path.guide}}/dev/code/index.html).
{% else %}
@@ -84,7 +84,7 @@ provides a template to follow.
## Deploying the Application
If you have not already done so, follow the section in the
-[Getting Started Guide]({{site.url}}/use/guide/quickstart/index.html) to create a `brooklyn.properties`
+[Getting Started Guide]({{site.path.guide}}/use/guide/quickstart/index.html) to create a `brooklyn.properties`
file containing credentials for your preferred cloud provider.
To launch this application, build the project and run the `start.sh` script in the resulting assembly:
@@ -187,16 +187,16 @@ Fire up a JMeter session (or other load testing tool) and blast the Nginx addres
In addition to the sample project created by the archetype, with its README and
`assembly` build, you can find additional code related to this example included with Brooklyn as the ``simple-web-cluster`` example,
-described [in detail here]({{site.url}}/use/examples/webcluster).
+described [in detail here]({{site.path.guide}}/use/examples/webcluster).
For your applications, you might want to mix in other data stores, messaging systems, or on-line services including PaaS.
Brooklyn supports some of these out-of-the-box, including a wide-range of tools which it can use Whirr to provision, such as Hadoop.
But if you have something you don't see,
-[let us know]({{site.url}}/meta/contact.html) --
+[let us know]({{site.path.guide}}/meta/contact.html) --
we want to work with you to
-[write a new entity]({{site.url}}/dev/code/entity.html) or
-[policy]({{site.url}}/dev/code/policy.html)
-and [contribute it]({{site.url}}/dev/how-to-contrib.html).
+[write a new entity]({{site.path.guide}}/dev/code/entity.html) or
+[policy]({{site.path.guide}}/dev/code/policy.html)
+and [contribute it]({{site.path.guide}}/dev/how-to-contrib.html).
<!--
@@ -225,7 +225,7 @@ Alternatively you can just add a ``main`` method to the application class as fol
}
{% endhighlight %}
-Compile and run this with the [``brooklyn-all`` jar]({{site.url}}/start/download.html) on the classpath,
+Compile and run this with the [``brooklyn-all`` jar]({{site.path.guide}}/start/download.html) on the classpath,
pointing at your favourite WAR on your filesystem.
(If the ``import`` packages aren't picked up correctly,
you can cheat by looking at [the file in Github](https://github.com/brooklyncentral/brooklyn/blob/master/examples/simple-web-cluster/src/main/java/brooklyn/demo/WebClusterDatabaseExample.java);
@@ -235,6 +235,6 @@ and you'll find a sample WAR which uses the database as configured above
If you want to adventure beyond ``localhost`` (the default),
simply supply the your favourite cloud (e.g. ``aws-ec2:eu-west-1``)
-with credentials set up as described [here]({{ site.url }}/use/guide/management/index.html#startup-config).
+with credentials set up as described [here]({{ site.path.guide }}/use/guide/management/index.html#startup-config).
-->
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/toc-menu.json
----------------------------------------------------------------------
diff --git a/docs/guide/toc-menu.json b/docs/guide/toc-menu.json
index 824bbbe..6c1e3c3 100644
--- a/docs/guide/toc-menu.json
+++ b/docs/guide/toc-menu.json
@@ -1,20 +1,20 @@
[
{ "title": "Overview",
- "file": "{{ site.url }}/index.html" },
+ "file": "{{ site.path.guide }}/index.html" },
{ "title": "Download",
- "file": "{{ site.url }}/start/download.html" },
+ "file": "{{ site.path.guide }}/start/download.html" },
{ "title": "Getting Started",
- "file": "{{ site.url }}/use/guide/quickstart/index.html" },
+ "file": "{{ site.path.guide }}/use/guide/quickstart/index.html" },
{ "title": "Walkthrough",
- "file": "{{ site.url }}/start/walkthrough/index.html" },
+ "file": "{{ site.path.guide }}/start/walkthrough/index.html" },
{ "title": "User Guide",
- "file": "{{ site.url }}/use/guide/index.html",
- "children": {% readj ./use/guide/toc.json %} },
+ "file": "{{ site.path.guide }}/use/guide/index.html",
+ "children": {% readj use/guide/toc.json %} },
{ "title": "Examples",
- "file": "{{ site.url }}/use/examples/index.html",
- "children": {% readj ./use/examples/toc.json %} },
+ "file": "{{ site.path.guide }}/use/examples/index.html",
+ "children": {% readj use/examples/toc.json %} },
{ "title": "Contributing",
- "file": "{{ site.url }}/dev/code/index.html",
+ "file": "{{ site.path.guide }}/dev/code/index.html",
"exclude": true,
- "children": {% readj /dev/toc.json %} }
+ "children": {% readj dev/toc.json %} }
]
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/toc.json
----------------------------------------------------------------------
diff --git a/docs/guide/toc.json b/docs/guide/toc.json
index 79f9e5d..07d4c5c 100644
--- a/docs/guide/toc.json
+++ b/docs/guide/toc.json
@@ -1,21 +1,21 @@
[
{ "title": "Start",
- "file": "{{ site.url }}/start/index.html",
+ "file": "{{ site.path.guide }}/start/index.html",
"exclude": true,
- "children": {% readj /start/toc.json %} },
+ "children": {% readj start/toc.json %} },
{ "title": "Using brooklyn",
- "file": "{{ site.url }}/use/index.html",
- "children": {% readj /use/toc.json %} },
+ "file": "{{ site.path.guide }}/use/index.html",
+ "children": {% readj use/toc.json %} },
{ "title": "Contributing",
- "file": "{{ site.url }}/dev/code/index.html",
+ "file": "{{ site.path.guide }}/dev/code/index.html",
"exclude": true,
- "children": {% readj /dev/toc.json %} },
+ "children": {% readj dev/toc.json %} },
{ "title": "License",
- "file": "{{ site.url }}/license/index.html",
+ "file": "{{ site.path.guide }}/license/index.html",
"exclude": true,
- "children": {% readj /license/toc.json %} },
+ "children": {% readj license/toc.json %} },
{ "title": "Meta",
- "file": "{{ site.url }}/meta/versions.html",
+ "file": "{{ site.path.guide }}/meta/versions.html",
"exclude": true,
- "children": {% readj /meta/toc.json %} }
+ "children": {% readj meta/toc.json %} }
]
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/use/api/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/use/api/index.md b/docs/guide/use/api/index.md
index 143c345..c44b6e3 100644
--- a/docs/guide/use/api/index.md
+++ b/docs/guide/use/api/index.md
@@ -6,6 +6,6 @@ toc: ../../toc.json
*Javadoc is not available as part of this build.*
-Please see the [source code]({{site.url}}/dev/code) to view javadoc.
+Please see the [source code]({{site.path.guide}}/dev/code) to view javadoc.
<!-- This page is normally overwritten by generated javadoc. -->
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/use/contact.md
----------------------------------------------------------------------
diff --git a/docs/guide/use/contact.md b/docs/guide/use/contact.md
index 008a5a1..622cf0a 100644
--- a/docs/guide/use/contact.md
+++ b/docs/guide/use/contact.md
@@ -4,4 +4,4 @@ title: Contact
toc: ../toc.json
---
-{% readj /meta/contact.include.md %}
+{% readj ../meta/contact.include.md %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/use/examples/before-begin.include.md
----------------------------------------------------------------------
diff --git a/docs/guide/use/examples/before-begin.include.md b/docs/guide/use/examples/before-begin.include.md
index ad9bc19..2f71166 100644
--- a/docs/guide/use/examples/before-begin.include.md
+++ b/docs/guide/use/examples/before-begin.include.md
@@ -12,7 +12,7 @@ To use the examples, you'll need ``curl``, ``git``, ``java`` (1.6+), and ``maven
First, grab a copy of the Brooklyn snapshot distribution you wish to use from
[the Sonatype snapshot repo]({{ sonatype_repo_groupid_url }}brooklyn-dist/)
-(or build it yourself following instructions [here]({{ site.url }}/dev/build/)),
+(or build it yourself following instructions [here]({{ site.path.guide }}/dev/build/)),
unpack it to your favourite location (e.g. `$(pwd)`),
and export `BROOKLYN_HOME`:
@@ -52,6 +52,6 @@ For the latest stable version, go [here](/meta/versions.html).
{% endif %}
For more information on ways to download Brooklyn please
-see the [download page]({{site.url}}/start/download.html).
+see the [download page]({{site.path.guide}}/start/download.html).
For more information on the Brooklyn CLI and launching apps,
-please visit [this section of the user guide]({{site.url}}/use/guide/management/index.html#cli).
+please visit [this section of the user guide]({{site.path.guide}}/use/guide/management/index.html#cli).
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/use/examples/global-web-fabric/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/use/examples/global-web-fabric/index.md b/docs/guide/use/examples/global-web-fabric/index.md
index 7231cda..b59eae0 100644
--- a/docs/guide/use/examples/global-web-fabric/index.md
+++ b/docs/guide/use/examples/global-web-fabric/index.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Global Web Fabric
-toc: /toc.json
+toc: /guide/toc.json
---
This example shows how to build a multi-site web application *fabric*
@@ -375,4 +375,4 @@ Here are some questions to think about and code challenges to give you a steer f
between the different clusters.
This isn't for the faint-hearted, but whatever you create will certainly be of interest
to people in the Brooklyn community.
- Please [let us know]({{ site.url }}/meta/contact.html) what you've built!
+ Please [let us know]({{ site.path.guide }}/meta/contact.html) what you've built!
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/use/examples/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/use/examples/index.md b/docs/guide/use/examples/index.md
index 15e89dc..f55643f 100644
--- a/docs/guide/use/examples/index.md
+++ b/docs/guide/use/examples/index.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Examples
-toc: /toc.json
+toc: /guide/toc.json
---
We currently have the following examples on the site:
@@ -15,4 +15,4 @@ We currently have the following examples on the site:
There are examples in the code also, just check out the examples/ project.
-**Have one of your own?** [Add it here!]({{site.url}}/dev/tips/update-docs.html)
+**Have one of your own?** [Add it here!]({{site.path.guide}}/dev/tips/update-docs.html)
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/use/examples/messaging/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/use/examples/messaging/index.md b/docs/guide/use/examples/messaging/index.md
index 51fd0ae..0e38101 100644
--- a/docs/guide/use/examples/messaging/index.md
+++ b/docs/guide/use/examples/messaging/index.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Publish-Subscribe Messagiung
-toc: /toc.json
+toc: /guide/toc.json
---
This example shows how a simple messaging application can be build
@@ -170,7 +170,7 @@ messages, as follows:
### Cloud Deployment
With appropriate setup (as described
-[here]({{ site.url }}/use/guide/management/index.html#startup-config))
+[here]({{ site.path.guide }}/use/guide/management/index.html#startup-config))
this can also be deployed to your favourite cloud, let's pretend
it's Amazon Ireland, as follows:
@@ -179,5 +179,5 @@ it's Amazon Ireland, as follows:
{% endhighlight %}
If you encounter any difficulties, please
-[tell us]({{ site.url }}/meta/contact.html) and we'll do our best
+[tell us]({{ site.path.guide }}/meta/contact.html) and we'll do our best
to help.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/use/examples/nosql-cassandra/cassandra.include.md
----------------------------------------------------------------------
diff --git a/docs/guide/use/examples/nosql-cassandra/cassandra.include.md b/docs/guide/use/examples/nosql-cassandra/cassandra.include.md
index 8fd04ae..56319f8 100644
--- a/docs/guide/use/examples/nosql-cassandra/cassandra.include.md
+++ b/docs/guide/use/examples/nosql-cassandra/cassandra.include.md
@@ -49,7 +49,7 @@ If you want to run with more than one node in the cluster, you'll need to use a
that either points to multiple existing machines or to a cloud provider where you can
provision new machines.
-With appropriate setup of credentials (as described [here]({{ site.url }}/use/guide/management/index.html#startup-config))
+With appropriate setup of credentials (as described [here]({{ site.path.guide }}/use/guide/management/index.html#startup-config))
this example can also be deployed to your favourite cloud. Let's pretend it's Amazon US East, as follows:
{% highlight bash %}
@@ -279,4 +279,4 @@ If you want to try this with a real example application using the Cassandra clus
## Contact us!
-If you encounter any difficulties or have any comments, please [tell us]({{ site.url }}/meta/contact.html) and we'll do our best to help.
+If you encounter any difficulties or have any comments, please [tell us]({{ site.path.guide }}/meta/contact.html) and we'll do our best to help.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/use/examples/nosql-cassandra/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/use/examples/nosql-cassandra/index.md b/docs/guide/use/examples/nosql-cassandra/index.md
index 13caf53..88c1dce 100644
--- a/docs/guide/use/examples/nosql-cassandra/index.md
+++ b/docs/guide/use/examples/nosql-cassandra/index.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Cassandra Clusters
-toc: /toc.json
+toc: /guide/toc.json
---
{% readj cassandra.include.md %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/use/examples/simple-web-cluster.md
----------------------------------------------------------------------
diff --git a/docs/guide/use/examples/simple-web-cluster.md b/docs/guide/use/examples/simple-web-cluster.md
index e9ddac6..cd2b659 100644
--- a/docs/guide/use/examples/simple-web-cluster.md
+++ b/docs/guide/use/examples/simple-web-cluster.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Elastic Web Cluster
-toc: /toc.json
+toc: /guide/toc.json
---
<!-- file kept to preserve old links; remove when link not used -->
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/use/examples/toc.json
----------------------------------------------------------------------
diff --git a/docs/guide/use/examples/toc.json b/docs/guide/use/examples/toc.json
index 2f36c50..4bca3a1 100644
--- a/docs/guide/use/examples/toc.json
+++ b/docs/guide/use/examples/toc.json
@@ -1,13 +1,13 @@
[
{ "title": "Elastic Web Cluster",
- "file": "{{ site.url }}/use/examples/webcluster/index.html" },
+ "file": "{{ site.path.guide }}/use/examples/webcluster/index.html" },
{ "title": "Global Web Fabric",
- "file": "{{ site.url }}/use/examples/global-web-fabric/index.html" },
+ "file": "{{ site.path.guide }}/use/examples/global-web-fabric/index.html" },
{ "title": "Whirr Hadoop Cluster",
- "file": "{{ site.url }}/use/examples/whirrhadoop/index.html" },
+ "file": "{{ site.path.guide }}/use/examples/whirrhadoop/index.html" },
{ "title": "Publish-Subscribe Messaging",
- "file": "{{ site.url }}/use/examples/messaging/index.html" },
+ "file": "{{ site.path.guide }}/use/examples/messaging/index.html" },
{ "title": "Cassandra Cluster",
- "file": "{{ site.url }}/use/examples/nosql-cassandra/index.html" }
+ "file": "{{ site.path.guide }}/use/examples/nosql-cassandra/index.html" }
]
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/use/examples/webcluster.md
----------------------------------------------------------------------
diff --git a/docs/guide/use/examples/webcluster.md b/docs/guide/use/examples/webcluster.md
index e9ddac6..cd2b659 100644
--- a/docs/guide/use/examples/webcluster.md
+++ b/docs/guide/use/examples/webcluster.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Elastic Web Cluster
-toc: /toc.json
+toc: /guide/toc.json
---
<!-- file kept to preserve old links; remove when link not used -->
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/use/examples/webcluster/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/use/examples/webcluster/index.md b/docs/guide/use/examples/webcluster/index.md
index 43ea980..1fd80dd 100644
--- a/docs/guide/use/examples/webcluster/index.md
+++ b/docs/guide/use/examples/webcluster/index.md
@@ -1,7 +1,7 @@
---
layout: guide-normal
title: Elastic Web Cluster
-toc: /toc.json
+toc: /guide/toc.json
---
{% readj webcluster.include.md %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/use/examples/webcluster/webcluster.include.md
----------------------------------------------------------------------
diff --git a/docs/guide/use/examples/webcluster/webcluster.include.md b/docs/guide/use/examples/webcluster/webcluster.include.md
index 11e801b..e135998 100644
--- a/docs/guide/use/examples/webcluster/webcluster.include.md
+++ b/docs/guide/use/examples/webcluster/webcluster.include.md
@@ -50,7 +50,7 @@ Note that the installation may take some time, because the default deployment do
the official repos. You can monitor start-up activity for each entity in the ``Activity`` pane in the management console,
and see more detail by tailing the log file (``tail -f brooklyn.log``).
-With appropriate setup (as described [here]({{ site.url }}/use/guide/management/index.html#startup-config))
+With appropriate setup (as described [here]({{ site.path.guide }}/use/guide/management/index.html#startup-config))
this can also be deployed to your favourite cloud, let's pretend it's Amazon Ireland, as follows:
{% highlight bash %}
@@ -68,7 +68,7 @@ Ready for something more interesting? Try this:
--location localhost
{% endhighlight %}
-This launches the class ``WebClusterDatabaseExample`` (also described in the [walkthrough]({{ site.url }}/start/walkthrough/index.html))
+This launches the class ``WebClusterDatabaseExample`` (also described in the [walkthrough]({{ site.path.guide }}/start/walkthrough/index.html))
which launches a pool of web-servers -- of size 1 initially,
but manually configurable (if you stop the policy first, in the GUI, then use the ``resize`` effector) --
with an Nginx load-balancer set up in front of them, and backed by a MySQL database.
@@ -119,6 +119,6 @@ and a web-only cluster (no database) in `WebClusterExample``.
The webapp that is used is included under ``examples/hello-world-webapp``.
-You may wish to check out the [Global Web Fabric example]({{ site.url }}/use/examples/global-web-fabric/) next.
+You may wish to check out the [Global Web Fabric example]({{ site.path.guide }}/use/examples/global-web-fabric/) next.
-If you encounter any difficulties, please [tell us]({{ site.url }}/meta/contact.html) and we'll do our best to help.
+If you encounter any difficulties, please [tell us]({{ site.path.guide }}/meta/contact.html) and we'll do our best to help.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/use/guide/defining-applications/advanced-concepts.md
----------------------------------------------------------------------
diff --git a/docs/guide/use/guide/defining-applications/advanced-concepts.md b/docs/guide/use/guide/defining-applications/advanced-concepts.md
index 3b808f2..25b73ca 100644
--- a/docs/guide/use/guide/defining-applications/advanced-concepts.md
+++ b/docs/guide/use/guide/defining-applications/advanced-concepts.md
@@ -19,7 +19,7 @@ An application entity (``Application`` class) is responsible for starting the de
An ``Application``'s ``start()`` method begins provisioning the child entities of the application (and their entities, recursively).
Provisioning of entities typically happens in parallel automatically,
-although this can be customized. This is implemented as ***tasks*** which are tracked by the management plane and is visible in the [web-based management console]({{site.url}}/use/guide/management/index.html#console).
+although this can be customized. This is implemented as ***tasks*** which are tracked by the management plane and is visible in the [web-based management console]({{site.path.guide}}/use/guide/management/index.html#console).
Customized provisioning can be useful where two starting entities depend on each other. For example, it is often necessary to delay start of one entity until another entity reaches a certain state, and to supply run-time information about the latter to the former.
@@ -132,6 +132,6 @@ For example, a ``TomcatServer`` may implement start and other effectors using a
Particularly for sensors, some technologies are used so frequently that they are
packaged as ***feeds*** which can discover their configuration (including from drivers). These include JMX and HTTP (see ``JmxFeed`` and ``HttpFeed``).
-Brooklyn comes with entity implementations for a growing number of commonly used systems, including various web application servers, databases and NoSQL data stores, and messaging systems. See: [Extras]({{site.url}}/use/guide/extras/index.html).
+Brooklyn comes with entity implementations for a growing number of commonly used systems, including various web application servers, databases and NoSQL data stores, and messaging systems. See: [Extras]({{site.path.guide}}/use/guide/extras/index.html).
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/use/guide/defining-applications/basic-concepts.md
----------------------------------------------------------------------
diff --git a/docs/guide/use/guide/defining-applications/basic-concepts.md b/docs/guide/use/guide/defining-applications/basic-concepts.md
index 51d36a6..c9f6645 100644
--- a/docs/guide/use/guide/defining-applications/basic-concepts.md
+++ b/docs/guide/use/guide/defining-applications/basic-concepts.md
@@ -90,6 +90,6 @@ An entity consists of a Java interface (used when interacting with the entity) a
the entity's state in attributes (see `getAttribute(AttributeKey)``). If internal fields can be used then the data will be lost on brooklyn
restart, and may cause problems if the entity is to be moved to a different brooklyn management node.
-Next: [Advanced Concepts]({{site.url}}/use/guide/defining-applications/advanced-concepts.html).
-See also: [Management > Sensors and Effectors]({{site.url}}/use/guide/management/index.html#sensors-and-effectors).
+Next: [Advanced Concepts]({{site.path.guide}}/use/guide/defining-applications/advanced-concepts.html).
+See also: [Management > Sensors and Effectors]({{site.path.guide}}/use/guide/management/index.html#sensors-and-effectors).
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/use/guide/defining-applications/creating-yaml.md
----------------------------------------------------------------------
diff --git a/docs/guide/use/guide/defining-applications/creating-yaml.md b/docs/guide/use/guide/defining-applications/creating-yaml.md
index fab8426..7be1419 100644
--- a/docs/guide/use/guide/defining-applications/creating-yaml.md
+++ b/docs/guide/use/guide/defining-applications/creating-yaml.md
@@ -25,14 +25,14 @@ Here's a very simple YAML blueprint plan, to explain the structure:
* The `name` is just for the benefit of us humans.
* The `location` specifies where this should be deployed.
- If you've [set up passwordless localhost SSH access]({{ site.url }}/use/guide/locations/)
+ If you've [set up passwordless localhost SSH access]({{ site.path.guide }}/use/guide/locations/)
you can use `localhost` as above, but if not, just wait ten seconds for the next example.
* The `services` block takes a list of the typed services we want to deploy.
This is the meat of the blueprint plan, as you'll see below.
Finally, that clipboard in the corner lets you easily copy-and-paste into the web-console:
-simply [download and launch]({{ site.url }}/use/guide/quickstart/) Brooklyn,
+simply [download and launch]({{ site.path.guide }}/use/guide/quickstart/) Brooklyn,
then in the "Add Application" dialog at the web console
(usually [http://127.0.0.1:8081/](http://127.0.0.1:8081/).
There are several other ways to deploy, including `curl` and via the command-line,
@@ -75,7 +75,7 @@ YAML supports this, and sometimes that makes more readable plans.
(Although in this case a simple `location: localhost` is equivalent and even more succinct, but this is a tutorial.)
For more information see the Locations section of the [YAML reference](yaml-reference.html)
-and in the [User's Guide]({{ site.url }}/use/guide/locations/).
+and in the [User's Guide]({{ site.path.guide }}/use/guide/locations/).
Another good reference is the [template brooklyn.properties](/use/guide/quickstart/brooklyn.properties),
which if you install in `~/.brooklyn/brooklyn.properties` and edit with your credentials,
allows you to refer to clouds simply as `location: jclouds:aws-ec2:eu-west-1` or
@@ -97,7 +97,7 @@ ignored if deploying to `localhost` or `byon` fixed-IP machines.*
This will create a VM with the specified parameters in your choice of cloud.
In the GUI (and in the REST API), the entity is called "VM",
-and the hostname and IP address(es) are reported as [sensors]({{ site.url }}/use/guide/defining-applications/basic-concepts.html).
+and the hostname and IP address(es) are reported as [sensors]({{ site.path.guide }}/use/guide/defining-applications/basic-concepts.html).
There are many more `provisioning.properties` supported here,
including:
@@ -147,7 +147,7 @@ We've seen the configuration of machines and how to build up clusters.
Now let's return to our app-server example and explore how more interesting
services can be configured, composed, and combined.
-Also note there are some good overview materials [here]({{site.url}}//use/guide/defining-applications/basic-concepts.html)
+Also note there are some good overview materials [here]({{site.path.guide}}//use/guide/defining-applications/basic-concepts.html)
covering clusters, sensors, effectors and more,
if you're the kind of person who likes to learn more about concepts before seeing them in action.
@@ -401,17 +401,17 @@ TODO
### More Information
Plenty of examples of blueprints exist in the Brooklyn codebase,
-so a good starting point is to [`git clone`]({{ site.url }}/dev/code/index.html) it
+so a good starting point is to [`git clone`]({{ site.path.guide }}/dev/code/index.html) it
and search for `*.yaml` files therein.
Brooklyn lived as a Java framework for many years before we felt confident
to make a declarative front-end, so you can do pretty much anything you want to
by dropping to the JVM. Information on that is available:
-* in the [user guide]({{site.url}}/use/guide/entities/index.html),
-* through a [Maven archetype]({{site.url}}/use/guide/defining-applications/archetype.html),
+* in the [user guide]({{site.path.guide}}/use/guide/entities/index.html),
+* through a [Maven archetype]({{site.path.guide}}/use/guide/defining-applications/archetype.html),
* in the [codebase](https://github.com/brooklyncentral/brooklyn),
-* and in plenty of [examples]({{site.url}}/use/examples/index.html).
+* and in plenty of [examples]({{site.path.guide}}/use/examples/index.html).
You can also come talk to us, on IRC (#brooklyncentral on Freenode) or
-any of the usual [hailing frequencies]({{site.url}}/meta/contact.html),
+any of the usual [hailing frequencies]({{site.path.guide}}/meta/contact.html),
as these documents are a work in progress.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/use/guide/defining-applications/deploying-yaml.md
----------------------------------------------------------------------
diff --git a/docs/guide/use/guide/defining-applications/deploying-yaml.md b/docs/guide/use/guide/defining-applications/deploying-yaml.md
index d448cb1..a57e5c8 100644
--- a/docs/guide/use/guide/defining-applications/deploying-yaml.md
+++ b/docs/guide/use/guide/defining-applications/deploying-yaml.md
@@ -6,7 +6,7 @@ categories: [use, guide, defining-applications]
---
Once you've [written a YAML blueprint](creating-yaml.md), there are several ways to deploy it.
-These insructions assume you have [installed]({{ site.url }}/use/guide/quickstart/) Brooklyn.
+These insructions assume you have [installed]({{ site.path.guide }}/use/guide/quickstart/) Brooklyn.
You can then:
- Supply the YAML blueprint file on the CLI when launching the server:
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/use/guide/defining-applications/toc.json
----------------------------------------------------------------------
diff --git a/docs/guide/use/guide/defining-applications/toc.json b/docs/guide/use/guide/defining-applications/toc.json
index 08940a8..b4eeeef 100644
--- a/docs/guide/use/guide/defining-applications/toc.json
+++ b/docs/guide/use/guide/defining-applications/toc.json
@@ -1,19 +1,19 @@
[{ "title": "Basic Concepts",
- "file": "{{ site.url }}/use/guide/defining-applications/basic-concepts.html" },
+ "file": "{{ site.path.guide }}/use/guide/defining-applications/basic-concepts.html" },
{ "title": "Advanced Concepts",
- "file": "{{ site.url }}/use/guide/defining-applications/advanced-concepts.html" },
+ "file": "{{ site.path.guide }}/use/guide/defining-applications/advanced-concepts.html" },
{ "title": "Common Usage",
- "file": "{{ site.url }}/use/guide/defining-applications/common-usage.html" },
+ "file": "{{ site.path.guide }}/use/guide/defining-applications/common-usage.html" },
{ "title": "YAML Blueprints",
- "file": "{{ site.url }}/use/guide/defining-applications/creating-yaml.html" },
+ "file": "{{ site.path.guide }}/use/guide/defining-applications/creating-yaml.html" },
{ "title": "Chef Blueprints",
- "file": "{{ site.url }}/use/guide/defining-applications/chef-blueprints.html" },
+ "file": "{{ site.path.guide }}/use/guide/defining-applications/chef-blueprints.html" },
{ "title": "Deploying YAML",
- "file": "{{ site.url }}/use/guide/defining-applications/deploying-yaml.html" },
+ "file": "{{ site.path.guide }}/use/guide/defining-applications/deploying-yaml.html" },
{ "title": "YAML Reference",
- "file": "{{ site.url }}/use/guide/defining-applications/yaml-reference.html" },
+ "file": "{{ site.path.guide }}/use/guide/defining-applications/yaml-reference.html" },
{ "title": "Service State",
- "file": "{{ site.url }}/use/guide/defining-applications/service-state.html" },
+ "file": "{{ site.path.guide }}/use/guide/defining-applications/service-state.html" },
{ "title": "Maven Archetype",
- "file": "{{ site.url }}/use/guide/defining-applications/archetype.html" }
+ "file": "{{ site.path.guide }}/use/guide/defining-applications/archetype.html" }
]
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/use/guide/entities/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/use/guide/entities/index.md b/docs/guide/use/guide/entities/index.md
index dc7df88..f679611 100644
--- a/docs/guide/use/guide/entities/index.md
+++ b/docs/guide/use/guide/entities/index.md
@@ -108,7 +108,7 @@ wiring for the sensors, and the effector implementations. In simple cases it may
to capture the behaviour of the effectors in a simple methods.
For example deploying a WAR to a cluster can be done as follows:
-*This section is not complete. Feel free to [fork]({{site.url}}/dev/code) the docs and lend a hand.*
+*This section is not complete. Feel free to [fork]({{site.path.guide}}/dev/code) the docs and lend a hand.*
<!---
TODO show an effector which recurses across children
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/use/guide/entities/toc.json
----------------------------------------------------------------------
diff --git a/docs/guide/use/guide/entities/toc.json b/docs/guide/use/guide/entities/toc.json
index c6c68dd..69dbfb9 100644
--- a/docs/guide/use/guide/entities/toc.json
+++ b/docs/guide/use/guide/entities/toc.json
@@ -1,12 +1,12 @@
[{ "title": "Entity Lifecycle",
- "file": "{{ site.url }}/use/guide/entities/index.html#entity-lifestyle" },
+ "file": "{{ site.path.guide }}/use/guide/entities/index.html#entity-lifestyle" },
{ "title": "What to Extend",
- "file": "{{ site.url }}/use/guide/entities/index.html#implementation-classes" },
+ "file": "{{ site.path.guide }}/use/guide/entities/index.html#implementation-classes" },
{ "title": "Configuration",
- "file": "{{ site.url }}/use/guide/entities/index.html#configuration" },
+ "file": "{{ site.path.guide }}/use/guide/entities/index.html#configuration" },
{ "title": "Implementing Sensors",
- "file": "{{ site.url }}/use/guide/entities/index.html#implementing-sensors" },
+ "file": "{{ site.path.guide }}/use/guide/entities/index.html#implementing-sensors" },
{ "title": "Implementing Effectors",
- "file": "{{ site.url }}/use/guide/entities/index.html#implementing-effectors" },
+ "file": "{{ site.path.guide }}/use/guide/entities/index.html#implementing-effectors" },
{ "title": "Testing",
- "file": "{{ site.url }}/use/guide/entities/index.html#testing" }]
\ No newline at end of file
+ "file": "{{ site.path.guide }}/use/guide/entities/index.html#testing" }]
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/use/guide/extras/toc.json
----------------------------------------------------------------------
diff --git a/docs/guide/use/guide/extras/toc.json b/docs/guide/use/guide/extras/toc.json
index edf5cc7..3a4f11f 100644
--- a/docs/guide/use/guide/extras/toc.json
+++ b/docs/guide/use/guide/extras/toc.json
@@ -1,11 +1,11 @@
[{ "title": "Web",
- "file": "{{ site.url }}/use/guide/extras/index.html#web" },
+ "file": "{{ site.path.guide }}/use/guide/extras/index.html#web" },
{ "title": "Database",
- "file": "{{ site.url }}/use/guide/extras/index.html#database" },
+ "file": "{{ site.path.guide }}/use/guide/extras/index.html#database" },
{ "title": "NoSQL",
- "file": "{{ site.url }}/use/guide/extras/index.html#nosql" },
+ "file": "{{ site.path.guide }}/use/guide/extras/index.html#nosql" },
{ "title": "Messaging",
- "file": "{{ site.url }}/use/guide/extras/index.html#messaging" },
+ "file": "{{ site.path.guide }}/use/guide/extras/index.html#messaging" },
{ "title": "Provisioning",
- "file": "{{ site.url }}/use/guide/extras/index.html#provisioning" }
+ "file": "{{ site.path.guide }}/use/guide/extras/index.html#provisioning" }
]
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/use/guide/guide_toc.json
----------------------------------------------------------------------
diff --git a/docs/guide/use/guide/guide_toc.json b/docs/guide/use/guide/guide_toc.json
index a7cfff6..889353e 100644
--- a/docs/guide/use/guide/guide_toc.json
+++ b/docs/guide/use/guide/guide_toc.json
@@ -1,25 +1,25 @@
[
{ "title": "Start",
- "file": "{{ site.url }}/start/index.html" },
+ "file": "{{ site.path.guide }}/start/index.html" },
{ "title": "User Guide",
- "file": "{{ site.url }}/use/guide/index.html",
- "children": {% readj ./toc.json %} },
+ "file": "{{ site.path.guide }}/use/guide/index.html",
+ "children": {% readj toc.json %} },
{ "title": "Elsewhere",
- "file": "{{ site.url }}/start/index.html",
+ "file": "{{ site.path.guide }}/start/index.html",
"children": [
{ "title": "Examples",
- "file": "{{ site.url }}/use/examples/index.html",
- "children": {% readj /use/examples/toc.json %} },
+ "file": "{{ site.path.guide }}/use/examples/index.html",
+ "children": {% readj /guide/use/examples/toc.json %} },
{ "title": "API Reference",
- "file": "{{ site.url }}/use/api/index.html" },
+ "file": "{{ site.path.guide }}/use/api/index.html" },
{ "title": "Contributing",
- "file": "{{ site.url }}/dev/code/index.html",
- "children": {% readj /dev/toc.json %} },
+ "file": "{{ site.path.guide }}/dev/code/index.html",
+ "children": {% readj /guide/dev/toc.json %} },
{ "title": "License",
- "file": "{{ site.url }}/license/index.html" }
+ "file": "{{ site.path.guide }}/license/index.html" }
]}
]
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/use/guide/management/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/use/guide/management/index.md b/docs/guide/use/guide/management/index.md
index 576da81..6f65c81 100644
--- a/docs/guide/use/guide/management/index.md
+++ b/docs/guide/use/guide/management/index.md
@@ -286,7 +286,7 @@ TODO Describe how and when objects become "live", pushed out to other nodes.
Resilience
----------
TODO
-*This section still needs to be written. Feel free to [fork]({{site.url}}/dev/code) the docs and lend a hand.*
+*This section still needs to be written. Feel free to [fork]({{site.path.guide}}/dev/code) the docs and lend a hand.*
-->
@@ -296,7 +296,7 @@ Key APIs
<!---
TODO - brief overview of key APIs
-->
-*This section still needs to be written. Feel free to [fork]({{site.url}}/dev/code) the docs and lend a hand.*
+*This section still needs to be written. Feel free to [fork]({{site.path.guide}}/dev/code) the docs and lend a hand.*
- ``ManagementContext`` (Java management API)
- ``EntityLocal`` (used by policies)
@@ -353,7 +353,7 @@ TODO , etc., example
### SubscriptionManager
-*This section is not complete. Feel free to [fork]({{site.url}}/dev/code) the docs and lend a hand.*
+*This section is not complete. Feel free to [fork]({{site.path.guide}}/dev/code) the docs and lend a hand.*
*See the* ``SubscriptionManager`` *class.*
<!---
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2ac0c6d6/docs/guide/use/guide/management/toc.json
----------------------------------------------------------------------
diff --git a/docs/guide/use/guide/management/toc.json b/docs/guide/use/guide/management/toc.json
index f470c2d..e30d160 100644
--- a/docs/guide/use/guide/management/toc.json
+++ b/docs/guide/use/guide/management/toc.json
@@ -1,18 +1,18 @@
[{ "title": "Introduction",
- "file": "{{ site.url }}/use/guide/management/index.html#introduction" },
+ "file": "{{ site.path.guide }}/use/guide/management/index.html#introduction" },
{ "title": "Startup Configuration",
- "file": "{{ site.url }}/use/guide/management/index.html#startup-config" },
+ "file": "{{ site.path.guide }}/use/guide/management/index.html#startup-config" },
{ "title": "Command Line Interface",
- "file": "{{ site.url }}/use/guide/management/index.html#cli" },
+ "file": "{{ site.path.guide }}/use/guide/management/index.html#cli" },
{ "title": "Management Web Console",
- "file": "{{ site.url }}/use/guide/management/index.html#console" },
+ "file": "{{ site.path.guide }}/use/guide/management/index.html#console" },
{ "title": "Observation APIs",
- "file": "{{ site.url }}/use/guide/management/index.html#observation-other" },
+ "file": "{{ site.path.guide }}/use/guide/management/index.html#observation-other" },
{ "title": "Distributed Management",
- "file": "{{ site.url }}/use/guide/management/index.html#distributed-management" },
+ "file": "{{ site.path.guide }}/use/guide/management/index.html#distributed-management" },
{ "title": "Resilience",
- "file": "{{ site.url }}/use/guide/management/index.html#resilience" },
+ "file": "{{ site.path.guide }}/use/guide/management/index.html#resilience" },
{ "title": "Key APIs",
- "file": "{{ site.url }}/use/guide/management/index.html#key-apis" },
+ "file": "{{ site.path.guide }}/use/guide/management/index.html#key-apis" },
{ "title": "Sensors and Effectors",
- "file": "{{ site.url }}/use/guide/management/index.html#sensors-and-effectors" }]
\ No newline at end of file
+ "file": "{{ site.path.guide }}/use/guide/management/index.html#sensors-and-effectors" }]