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 2015/01/12 15:52:23 UTC
[7/9] incubator-brooklyn git commit: fixing a lot of broken links
fixing a lot of broken links
the most important ones are done i think, and catalog now in menu
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/08420058
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/08420058
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/08420058
Branch: refs/heads/master
Commit: 084200586aaac58ed871ddeb9a9d0130e8a8852e
Parents: 7333341
Author: Alex Heneveld <al...@cloudsoftcorp.com>
Authored: Fri Jan 9 20:40:29 2015 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
Committed: Sat Jan 10 23:09:19 2015 +0000
----------------------------------------------------------------------
docs/README.md | 7 +-
docs/_build/build.sh | 2 +-
docs/_includes/fields.md | 2 +-
docs/_includes/topmenu.html | 2 +-
docs/_plugins/site_structure.rb | 2 +
.../concepts/configuration-sensor-effectors.md | 3 +-
docs/guide/dev/env/ide/eclipse.include.md | 6 +-
.../guide/dev/tips/debugging-remote-brooklyn.md | 6 +-
docs/guide/java/entity.md | 2 +-
docs/guide/misc/release-notes.md | 4 +-
docs/guide/ops/locations/index.md | 2 +-
docs/guide/start/config.md | 2 +-
docs/guide/start/running.md | 4 +-
docs/guide/yaml/catalog-maintenance.md | 2 +-
docs/guide/yaml/chef/about-chef.md | 2 +-
docs/guide/yaml/chef/index.md | 2 +-
docs/guide/yaml/configuring-vms.md | 2 +-
docs/guide/yaml/creating-yaml.md | 28 ++--
docs/guide/yaml/setting-locations.md | 4 +-
docs/website/documentation/index.md | 2 +-
docs/website/download/index.md | 4 +-
docs/website/index.md | 2 +-
docs/website/learnmore/catalog/index.html | 147 -------------------
docs/website/learnmore/catalog/index.md | 131 +++++++++++++++++
docs/website/learnmore/index.md | 17 ++-
docs/website/meta/versions.md | 4 +-
26 files changed, 193 insertions(+), 198 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/README.md
----------------------------------------------------------------------
diff --git a/docs/README.md b/docs/README.md
index 7c07075..cfac91c 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -160,10 +160,15 @@ useful for testing.
Supported options beyond that include `--serve`, to start a web browser serving the content of `_site/`,
and `--skip-javadoc`, to speed up the build significantly by skipping javadoc generation.
A handy command for testing the live files, analogous to `jekyll serve`
-but with the correct file structure, is:
+but with the correct file structure, and then checking links, is:
_build/build.sh test-both --skip-javadoc --serve
+And to run link-checks quickly (without validating external links), use:
+
+ htmlproof --href_ignore "https?://127.*" --alt_ignore ".*" --disable_external _site
+
+
Preparing for a Release
-----------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/_build/build.sh
----------------------------------------------------------------------
diff --git a/docs/_build/build.sh b/docs/_build/build.sh
index 49d9087..74d8a30 100755
--- a/docs/_build/build.sh
+++ b/docs/_build/build.sh
@@ -154,7 +154,7 @@ function test_site() {
echo "Running htmlproof on _site"
mkdir -p target
LOG="target/htmlproof.log"
- htmlproof _site 2>&1 | tee $LOG
+ htmlproof _site --href_ignore "https?://127.*" --alt_ignore ".*" 2>&1 | tee $LOG
}
function make_jekyll() {
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/_includes/fields.md
----------------------------------------------------------------------
diff --git a/docs/_includes/fields.md b/docs/_includes/fields.md
index 10ac024..e6cff81 100644
--- a/docs/_includes/fields.md
+++ b/docs/_includes/fields.md
@@ -1,7 +1,7 @@
{% if site.brooklyn-version contains 'SNAPSHOT' %}{% capture SNAPSHOT %}true{% endcapture %}{% endif %}
-{% capture brooklyn_properties_url_path %}{{ site.path.guide }}/use/guide/quickstart/brooklyn.properties{% endcapture %}
+{% capture brooklyn_properties_url_path %}{{ site.path.guide }}/start/brooklyn.properties{% endcapture %}
{% capture brooklyn_properties_url_live %}{{ site.url_root }}{{ brooklyn_properties_url_path }}{% endcapture %}
{% capture brooklyn_group_id %}org.apache.brooklyn{% endcapture %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/_includes/topmenu.html
----------------------------------------------------------------------
diff --git a/docs/_includes/topmenu.html b/docs/_includes/topmenu.html
index d25b14a..b9d8e6f 100644
--- a/docs/_includes/topmenu.html
+++ b/docs/_includes/topmenu.html
@@ -2,7 +2,7 @@
<div class="container-and-sidebars">
<div class="container-sidebar-left">
- <img src="{{ site.path.style }}/img/feather.png" width="80" class="flip navbar-feather">
+ <img src="{{ site.path.style }}/img/feather.png" alt="[feather]" width="80" class="flip navbar-feather">
</div>
<div class="container container-between-sidebars top-menu">
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/_plugins/site_structure.rb
----------------------------------------------------------------------
diff --git a/docs/_plugins/site_structure.rb b/docs/_plugins/site_structure.rb
index 70a07b6..7d0303c 100644
--- a/docs/_plugins/site_structure.rb
+++ b/docs/_plugins/site_structure.rb
@@ -211,6 +211,7 @@ module SiteStructure
puts "setting up #{item} as link" if @@verbose
link = render_liquid(site, parent, item['link'])
data = { 'link' => link, 'url' => link }
+ data['title'] = item['title'] if item['title']
breadcrumb_pages << data
breadcrumb_paths << data['link']
data['data'] = data
@@ -226,6 +227,7 @@ module SiteStructure
data['menu_parent'] ||= parent
data['title_in_menu'] = render_liquid(site, parent, item['title_in_menu'] || item['title'] || data['title_in_menu'] || data['title'])
+ data['title'] ||= data['title_in_menu']
# puts "built #{data}, now looking at children"
# if already processed then return now that we have set custom item overrides (don't recurse through children)
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/guide/concepts/configuration-sensor-effectors.md
----------------------------------------------------------------------
diff --git a/docs/guide/concepts/configuration-sensor-effectors.md b/docs/guide/concepts/configuration-sensor-effectors.md
index 5d57b4d..47ec72e 100644
--- a/docs/guide/concepts/configuration-sensor-effectors.md
+++ b/docs/guide/concepts/configuration-sensor-effectors.md
@@ -38,6 +38,5 @@ 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.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).
+Next: [Advanced Concepts](advanced-concepts.html).
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/guide/dev/env/ide/eclipse.include.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/env/ide/eclipse.include.md b/docs/guide/dev/env/ide/eclipse.include.md
index b1cf5ea..76fe927 100644
--- a/docs/guide/dev/env/ide/eclipse.include.md
+++ b/docs/guide/dev/env/ide/eclipse.include.md
@@ -6,10 +6,8 @@
(typically bundled with Eclipse or available in the default update site set)
- Groovy Plugin: GRECLIPSE from
- [dist.springsource.org/release/GRECLIPSE/e4.3](http://dist.springsource.org/release/GRECLIPSE/e4.3)
- (or for Eclipse [4.2](http://dist.springsource.org/release/GRECLIPSE/e4.2)
- or [3.7](http://dist.springsource.org/release/GRECLIPSE/e3.7)).
+ [dist.springsource.org/release/GRECLIPSE/e4.3/](http://dist.springsource.org/release/GRECLIPSE/e4.3/);
Be sure to include Groovy 2.3.4 compiler support and Maven-Eclipse (m2e) support.
- More details are at the [groovy update site](http://groovy.codehaus.org/Eclipse+Plugin).
+ More details including download sites for other versions can be found at the [Groovy Eclipse Plugin site](http://groovy.codehaus.org/Eclipse+Plugin).
- TestNG Plugin: beust TestNG from [beust.com/eclipse](http://beust.com/eclipse)
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/guide/dev/tips/debugging-remote-brooklyn.md
----------------------------------------------------------------------
diff --git a/docs/guide/dev/tips/debugging-remote-brooklyn.md b/docs/guide/dev/tips/debugging-remote-brooklyn.md
index 337aa21..23857e3 100644
--- a/docs/guide/dev/tips/debugging-remote-brooklyn.md
+++ b/docs/guide/dev/tips/debugging-remote-brooklyn.md
@@ -4,7 +4,7 @@ title: Brooklyn Remote Debugging
toc: /guide/toc.json
---
-Usually during development, you will be running Brooklyn from your IDE (see [IDE Setup](ide.html)), in which case
+Usually during development, you will be running Brooklyn from your IDE (see [IDE Setup](../env/ide/)), in which case
debugging is as simple as setting a breakpoint. There may however be times when you need to debug an existing remote
Brooklyn instance (often referred to as Resident Brooklyn, or rBrooklyn) on another machine, usually in the cloud.
@@ -108,7 +108,7 @@ Setting up your IDE will differ depending upon which IDE you are using. Instruct
IntelliJ, and have been tested with Eclipse Luna and IntelliJ Ultimate 14.
### Eclipse Setup
-To debug using Eclipse, first open the Brooklyn project in Eclipse (see [IDE Setup](ide.html)).
+To debug using Eclipse, first open the Brooklyn project in Eclipse (see [IDE Setup](../env/ide/)).
Now create a debug configuration by clicking `Run` | `Debug Configurations...`. You will then be presented with the
Debug Configuration dialog.
@@ -119,7 +119,7 @@ Connection Type should be set to 'Standard (Socket Attach)'. The Host should be
and the Port should be set to 8888. Click 'Debug' to start debugging.
### IntelliJ Setup
-To debug using IntelliJ, first open the Brooklyn project in IntelliJ (see [IDE Setup](ide.html)).
+To debug using IntelliJ, first open the Brooklyn project in IntelliJ (see [IDE Setup](../env/ide/)).
Now create a debug configuration by clicking `Run` | `Edit Configurations`. You will then be presented with the
Run/Debug Configurations dialog.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/guide/java/entity.md
----------------------------------------------------------------------
diff --git a/docs/guide/java/entity.md b/docs/guide/java/entity.md
index 84c1b8e..6d780be 100644
--- a/docs/guide/java/entity.md
+++ b/docs/guide/java/entity.md
@@ -86,5 +86,5 @@ hierarchy; it is suggested to avoid these, looking at the ones below instead):
You might also find the following helpful:
* **[Entity Design Tips]({{site.path.guide}}/dev/tips/index.html#EntityDesign)**
-* The **[User Guide]({{site.path.guide}}/use/guide/index.html)**
+* The **[User Guide]({{site.path.guide}})**
* The **[Mailing List](https://mail-archives.apache.org/mod_mbox/incubator-brooklyn-dev/)**
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/guide/misc/release-notes.md
----------------------------------------------------------------------
diff --git a/docs/guide/misc/release-notes.md b/docs/guide/misc/release-notes.md
index 66a443a..c2f49a2 100644
--- a/docs/guide/misc/release-notes.md
+++ b/docs/guide/misc/release-notes.md
@@ -5,8 +5,6 @@ title: Release Notes
## Version {{ site.brooklyn-version }}
-TODO: breacrumbs {{ page.breadcrumb_paths }}.
-
{% if SNAPSHOT %}
**You are viewing a SNAPSHOT release (master branch), so this list is incomplete.**
{% endif %}
@@ -37,7 +35,7 @@ For more information, please visit [brooklyn.io](http://brooklyn.io).
* Networking
-* Docker support: see [clocker.io](clocker.io)
+* Docker support: see [clocker.io](http://clocker.io)
### Backwards Compatibility
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/guide/ops/locations/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/ops/locations/index.md b/docs/guide/ops/locations/index.md
index 2e3c092..4fc3b98 100644
--- a/docs/guide/ops/locations/index.md
+++ b/docs/guide/ops/locations/index.md
@@ -68,7 +68,7 @@ brooklyn.location.named.AWS\ Virginia\ Large\ Centos.minRam=4096
This will appear as 'AWS Virginia Large Centos' in the web console, but will need to be escaped on the command line as: `AWS\ Virginia\ Large\ Centos`.
-See the Getting Started [template brooklyn.properties](../quickstart/brooklyn.properties) for more examples of using cloud endpoints.
+See the Getting Started [template brooklyn.properties](../start/brooklyn.properties) for more examples of using cloud endpoints.
## Fixed Infrastructure
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/guide/start/config.md
----------------------------------------------------------------------
diff --git a/docs/guide/start/config.md b/docs/guide/start/config.md
index 125553b..016834d 100644
--- a/docs/guide/start/config.md
+++ b/docs/guide/start/config.md
@@ -44,7 +44,7 @@ Some sample settings for this are:
brooklyn.location.named.softlayer-dal05 = jclouds:softlayer:dal05
brooklyn.location.named.softlayer-dal05.displayName = Softlayer Dallas
-If you want to test Brooklyn on localhost, follow [these instructions]({{site.path.guide}}/use/guide/locations/)
+If you want to test Brooklyn on localhost, follow [these instructions]({{site.path.guide}}/ops/locations/)
to ensure that your Brooklyn can access your machine.
Once updated, restart Brooklyn (or reload the properties within the web GUI).
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/guide/start/running.md
----------------------------------------------------------------------
diff --git a/docs/guide/start/running.md b/docs/guide/start/running.md
index db6d525..cb1cfe7 100644
--- a/docs/guide/start/running.md
+++ b/docs/guide/start/running.md
@@ -11,7 +11,7 @@ This tutorial assumes that you are using Linux or Mac OSX.
## Install Brooklyn
-Download Brooklyn and obtain a binary build as described on [the download page]({{site.path.website}}/download.html).
+Download Brooklyn and obtain a binary build as described on [the download page]({{site.path.website}}/download/).
{% if brooklyn_version contains 'SNAPSHOT' %}
Expand the `tar.gz` archive (note: as this is a -SNAPSHOT version, your filename will be slightly different):
@@ -68,7 +68,7 @@ then answer 'yes', and then repeat the command run again.
If the response is `hello world`, with no other output or prompts, then your SSH setup is good and Brooklyn should be
able to use it without a problem.
-If these steps are not working, [these instructions]({{ site.path.guide }}/use/guide/locations/) may be
+If these steps are not working, [these instructions]({{ site.path.guide }}/ops/locations/) may be
useful.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/guide/yaml/catalog-maintenance.md
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/catalog-maintenance.md b/docs/guide/yaml/catalog-maintenance.md
index edba8e8..d8eb877 100644
--- a/docs/guide/yaml/catalog-maintenance.md
+++ b/docs/guide/yaml/catalog-maintenance.md
@@ -5,7 +5,7 @@ toc: ../guide_toc.json
categories: [use, guide, catalog-maintenance]
---
-In addition to deploying [YAML blueprints](creating-yaml.md) directly through the web console, it is possible
+In addition to deploying [YAML blueprints](creating-yaml.html) directly through the web console, it is possible
to add YAML blueprints to the catalog via Brooklyn's REST API.
The catalog is a collection of versioned blueprints, which can be deployed directly or referenced
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/guide/yaml/chef/about-chef.md
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/chef/about-chef.md b/docs/guide/yaml/chef/about-chef.md
index 66207bc..0c7dcd6 100644
--- a/docs/guide/yaml/chef/about-chef.md
+++ b/docs/guide/yaml/chef/about-chef.md
@@ -40,7 +40,7 @@ itself to the server, passing on its configuration.
This diagram summarises the interaction between Brooklyn, the new node, and the various Chef tools. Note that there
is no interaction between the AMP Server and the Chef Server.
-[](Chef.png)
+[](chef-call-flow.png)
### How Brooklyn interacts with Chef
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/guide/yaml/chef/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/chef/index.md b/docs/guide/yaml/chef/index.md
index 2f47aa3..f0fa3d0 100644
--- a/docs/guide/yaml/chef/index.md
+++ b/docs/guide/yaml/chef/index.md
@@ -13,6 +13,6 @@ As of this writing (May 2014) some of the integration points are under active de
and comments are welcome.
A plan for the full integration is online [here](https://docs.google.com/a/cloudsoftcorp.com/document/d/18ZwzmncbJgJeQjnSvMapTWg6N526cvGMz5jaqdkxMf8).
-This guide assumes you are familiar with the basics of [creating YAML blueprints](creating-yaml.html).
+This guide assumes you are familiar with the basics of [creating YAML blueprints](../).
{% include list-children.html %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/guide/yaml/configuring-vms.md
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/configuring-vms.md b/docs/guide/yaml/configuring-vms.md
index db08f0b..280fa19 100644
--- a/docs/guide/yaml/configuring-vms.md
+++ b/docs/guide/yaml/configuring-vms.md
@@ -18,7 +18,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.path.guide }}/use/guide/defining-applications/basic-concepts.html).
+and the hostname and IP address(es) are reported as [sensors]({{ site.path.guide }}/concepts/entities.html).
There are many more `provisioning.properties` supported here,
including:
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/guide/yaml/creating-yaml.md
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/creating-yaml.md b/docs/guide/yaml/creating-yaml.md
index 8b1b593..012c67e 100644
--- a/docs/guide/yaml/creating-yaml.md
+++ b/docs/guide/yaml/creating-yaml.md
@@ -25,18 +25,19 @@ 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.path.guide }}/use/guide/locations/)
+ If you've [set up passwordless localhost SSH access](setting-locations.html#localhost)
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.path.guide }}/use/guide/quickstart/) Brooklyn,
+simply [download and launch]({{ site.path.guide }}/start/running.html) 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,
-and you can configure https and security, and much more, as described [here](deploying-yaml.html).
+and you can configure users, https, persistence, and more,
+as described [in the ops guide](../ops/).
[](web-console-yaml.png)
@@ -47,13 +48,6 @@ TODO building up children entities
-->
-<!--
-
-### Using Chef Recipes
-
-TODO
-
--->
### More Information
@@ -64,12 +58,14 @@ 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.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/apache/incubator-brooklyn),
-* and in plenty of [examples]({{site.path.guide}}/use/examples/index.html).
+by dropping to the JVM. For more information on this:
+* start with a [Maven archetype]({{site.path.guide}}/java/archetype.html)
+* see all [Brooklyn Java guide]({{site.path.guide}}/java/) topics
+* look at test cases in the [codebase](https://github.com/apache/incubator-brooklyn)
+<!-- TODO
+* review some [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.path.guide}}/meta/contact.html),
+any of the usual [hailing frequencies]({{site.path.website}}/community/),
as these documents are a work in progress.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/guide/yaml/setting-locations.md
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/setting-locations.md b/docs/guide/yaml/setting-locations.md
index 6feffe3..d279460 100644
--- a/docs/guide/yaml/setting-locations.md
+++ b/docs/guide/yaml/setting-locations.md
@@ -37,8 +37,8 @@ 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.path.guide }}/use/guide/locations/).
-Another good reference is the [template brooklyn.properties](/use/guide/quickstart/brooklyn.properties),
+and in the [Operations]({{ site.path.guide }}/ops/locations) section of the User Guide.
+Another good reference is the [template brooklyn.properties]({{ brooklyn_properties_url_path }}),
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
set up "named locations" you can use as `location: named:my_cloudstack`.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/website/documentation/index.md
----------------------------------------------------------------------
diff --git a/docs/website/documentation/index.md b/docs/website/documentation/index.md
index 67aaa9c..13f4d3d 100644
--- a/docs/website/documentation/index.md
+++ b/docs/website/documentation/index.md
@@ -28,4 +28,4 @@ From the links above you can also access the Developer Guide for the relevant ve
## Other Docs
-Many other mini-docs are available [here](other-docs.md).
+Many other mini-docs are available [here](other-docs.html).
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/website/download/index.md
----------------------------------------------------------------------
diff --git a/docs/website/download/index.md b/docs/website/download/index.md
index 690c856..33f5d16 100644
--- a/docs/website/download/index.md
+++ b/docs/website/download/index.md
@@ -9,7 +9,7 @@ children:
[Download Apache Brooklyn {{ site.data.brooklyn.version }} from our mirror sites](https://www.apache.org/dyn/closer.cgi/incubator/brooklyn/{{ site.data.brooklyn.version }}/apache-brooklyn-{{ site.data.brooklyn.version }}.tar.gz)
-You can also verify that you build has not been tampered with by [verifying the hashes and signatures](download/verify.html).
+You can also verify that you build has not been tampered with by [verifying the hashes and signatures](verify.html).
## Build the Binary Package
@@ -29,7 +29,7 @@ You can then find the binary distribution in the folder `usage/dist/target/brook
## Get Started!
-Take a look at the [Get Started](quickstart/) page!
+Take a look at the [Get Started]({{ site.path.guide }}/start/running.html) page!
## Previous Versions
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/website/index.md
----------------------------------------------------------------------
diff --git a/docs/website/index.md b/docs/website/index.md
index dac0968..bfb50fa 100644
--- a/docs/website/index.md
+++ b/docs/website/index.md
@@ -69,7 +69,7 @@ View and modify using the *web console* or automate using the *REST API*
<div style="text-align: center" markdown="1">
<a class="btn btn-primary btn-lg" role="button" href="learnmore/">learn more</a>
-<a class="btn btn-primary btn-lg" role="button" href="quickstart/">get started</a>
+<a class="btn btn-primary btn-lg" role="button" href="{{ site.path.guide }}/start/running.html">get started</a>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/website/learnmore/catalog/index.html
----------------------------------------------------------------------
diff --git a/docs/website/learnmore/catalog/index.html b/docs/website/learnmore/catalog/index.html
deleted file mode 100644
index 4487346..0000000
--- a/docs/website/learnmore/catalog/index.html
+++ /dev/null
@@ -1,147 +0,0 @@
-<!DOCTYPE html>
-<!--
-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.
--->
-<html lang="en">
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <meta name="viewport" content="width=device-width, initial-scale=1">
- <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css">
- <link rel="stylesheet" href="items.css" type="text/css" media="screen"/>
- <title>Brooklyn Objects</title>
- </head>
-
- <body>
- <div id="container">
- <div id="header">
- <div id="identity">
- <a href="https://brooklyn.incubator.apache.org/" rel="home">Brooklyn</a>
- </div>
- </div>
-
- <ul class="nav nav-tabs">
- <li class="active"><a href="#entities" data-toggle="tab">Entities</a></li>
- <li><a href="#policies" data-toggle="tab">Policies</a></li>
- <li><a href="#enrichers" data-toggle="tab">Enrichers</a></li>
- </ul>
-
- <div class="tab-content">
- <div class="tab-pane active" id="entities">
- <input class="filter form-control" type="text" placeholder="Filter by type, e.g. webapp or nosql">
- </div>
- <div class="tab-pane" id="policies">
- <input class="filter form-control" type="text" placeholder="Filter by type, e.g. ha">
- </div>
- <div class="tab-pane" id="enrichers">
- <input class="filter form-control" type="text" placeholder="Filter by type, e.g. http">
- </div>
- <div class="tab-pane" id="locations"></div>
- <div class="tab-pane" id="locationResolvers"></div>
- </div>
- </div>
-
- <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js" type="text/javascript"></script>
- <script src="../../style/js/underscore-min.js" type="text/javascript"></script>
- <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script>
- <script src="libs/js/bloodhound.js" type="text/javascript"></script>
- <script src="common.js" type="text/javascript"></script>
- <script src="items.js" type="text/javascript"></script>
- <script type="text/javascript">
- if (!String.prototype.trim) {
- String.prototype.trim = function () {
- return this.replace(/^\s+|\s+$/g, '');
- };
- }
- var card = function (collection, cardFunction, target) {
- var cards = _.map(collection, cardFunction);
- $(target).append(cards.join(""));
- };
- var ESCAPE_KEY = 27;
-
- var filter = function (element) {
- var $element = $(element),
- $tab = $element.parent(),
- kind = $tab.attr("id"),
- collection = items[kind];
- if (!collection) {
- console.warn("Unable to determine type for input", element);
- return;
- }
-
- // Number.MAX_VALUE configures Bloodhound to return all matches.
- var bloodhound = new Bloodhound({
- name: kind,
- local: collection,
- limit: Number.MAX_VALUE,
- datumTokenizer: function (d) {
- return Bloodhound.tokenizers.nonword(d.type);
- },
- queryTokenizer: Bloodhound.tokenizers.nonword
- });
- bloodhound.initialize();
-
- // Filter items as input changes
- var allAnchors = $tab.find("a").map(function (index, a) { return $(a); });
- var hideAnchorsNotMatchingQuery = function () {
- var query = $element.val();
- query = query.trim();
- if (!query) {
- $tab.find("a").removeClass("hide");
- } else {
- var matchedTypes = {};
- bloodhound.get(query, function (suggestions) {
- _.each(suggestions, function (s) {
- // approximate a set!
- matchedTypes[s.type] = true;
- });
- });
- _.each(allAnchors, function (a) {
- if (_.has(matchedTypes, a.data("type"))) {
- a.removeClass("hide");
- } else {
- a.addClass("hide");
- }
- });
- }
- };
- $element.on("input", hideAnchorsNotMatchingQuery);
- // In case page is loaded with text in input, e.g. from back button.
- hideAnchorsNotMatchingQuery();
-
- $element.on("keydown", function (e) {
- if (e.keyCode == ESCAPE_KEY) {
- $element.val("");
- hideAnchorsNotMatchingQuery();
- }
- });
- };
-
- $(document).ready(function () {
- card(items.entities, brooklyn.entityCard, "#entities");
- card(items.policies, brooklyn.policyCard, "#policies");
- card(items.enrichers, brooklyn.enricherCard, "#enrichers");
- //transformItemAndAddToElement(items.locations, brooklyn.locationCard, "#locations");
- //items.locationResolvers.forEach(function (element) { $("#locationResolvers").append("<tr><td>" + element + "</td></tr>"); });
- $("input.filter").each(function (index, element) {
- filter(element);
- });
- });
- </script>
- </body>
-</html>
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/website/learnmore/catalog/index.md
----------------------------------------------------------------------
diff --git a/docs/website/learnmore/catalog/index.md b/docs/website/learnmore/catalog/index.md
new file mode 100644
index 0000000..98f8a96
--- /dev/null
+++ b/docs/website/learnmore/catalog/index.md
@@ -0,0 +1,131 @@
+---
+title: Catalog
+---
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+ <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css">
+ <link rel="stylesheet" href="items.css" type="text/css" media="screen"/>
+ <title>Brooklyn Objects</title>
+ </head>
+
+ <body>
+ <div id="container">
+ <div id="header">
+ <div id="identity">
+ <a href="https://brooklyn.incubator.apache.org/" rel="home">Brooklyn</a>
+ </div>
+ </div>
+
+ <ul class="nav nav-tabs">
+ <li class="active"><a href="#entities" data-toggle="tab">Entities</a></li>
+ <li><a href="#policies" data-toggle="tab">Policies</a></li>
+ <li><a href="#enrichers" data-toggle="tab">Enrichers</a></li>
+ </ul>
+
+ <div class="tab-content">
+ <div class="tab-pane active" id="entities">
+ <input class="filter form-control" type="text" placeholder="Filter by type, e.g. webapp or nosql">
+ </div>
+ <div class="tab-pane" id="policies">
+ <input class="filter form-control" type="text" placeholder="Filter by type, e.g. ha">
+ </div>
+ <div class="tab-pane" id="enrichers">
+ <input class="filter form-control" type="text" placeholder="Filter by type, e.g. http">
+ </div>
+ <div class="tab-pane" id="locations"></div>
+ <div class="tab-pane" id="locationResolvers"></div>
+ </div>
+ </div>
+
+ <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js" type="text/javascript"></script>
+ <script src="../../style/js/underscore-min.js" type="text/javascript"></script>
+ <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script>
+ <script src="libs/js/bloodhound.js" type="text/javascript"></script>
+ <script src="common.js" type="text/javascript"></script>
+ <script src="items.js" type="text/javascript"></script>
+ <script type="text/javascript">
+ if (!String.prototype.trim) {
+ String.prototype.trim = function () {
+ return this.replace(/^\s+|\s+$/g, '');
+ };
+ }
+ var card = function (collection, cardFunction, target) {
+ var cards = _.map(collection, cardFunction);
+ $(target).append(cards.join(""));
+ };
+ var ESCAPE_KEY = 27;
+
+ var filter = function (element) {
+ var $element = $(element),
+ $tab = $element.parent(),
+ kind = $tab.attr("id"),
+ collection = items[kind];
+ if (!collection) {
+ console.warn("Unable to determine type for input", element);
+ return;
+ }
+
+ // Number.MAX_VALUE configures Bloodhound to return all matches.
+ var bloodhound = new Bloodhound({
+ name: kind,
+ local: collection,
+ limit: Number.MAX_VALUE,
+ datumTokenizer: function (d) {
+ return Bloodhound.tokenizers.nonword(d.type);
+ },
+ queryTokenizer: Bloodhound.tokenizers.nonword
+ });
+ bloodhound.initialize();
+
+ // Filter items as input changes
+ var allAnchors = $tab.find("a").map(function (index, a) { return $(a); });
+ var hideAnchorsNotMatchingQuery = function () {
+ var query = $element.val();
+ query = query.trim();
+ if (!query) {
+ $tab.find("a").removeClass("hide");
+ } else {
+ var matchedTypes = {};
+ bloodhound.get(query, function (suggestions) {
+ _.each(suggestions, function (s) {
+ // approximate a set!
+ matchedTypes[s.type] = true;
+ });
+ });
+ _.each(allAnchors, function (a) {
+ if (_.has(matchedTypes, a.data("type"))) {
+ a.removeClass("hide");
+ } else {
+ a.addClass("hide");
+ }
+ });
+ }
+ };
+ $element.on("input", hideAnchorsNotMatchingQuery);
+ // In case page is loaded with text in input, e.g. from back button.
+ hideAnchorsNotMatchingQuery();
+
+ $element.on("keydown", function (e) {
+ if (e.keyCode == ESCAPE_KEY) {
+ $element.val("");
+ hideAnchorsNotMatchingQuery();
+ }
+ });
+ };
+
+ $(document).ready(function () {
+ card(items.entities, brooklyn.entityCard, "#entities");
+ card(items.policies, brooklyn.policyCard, "#policies");
+ card(items.enrichers, brooklyn.enricherCard, "#enrichers");
+ //transformItemAndAddToElement(items.locations, brooklyn.locationCard, "#locations");
+ //items.locationResolvers.forEach(function (element) { $("#locationResolvers").append("<tr><td>" + element + "</td></tr>"); });
+ $("input.filter").each(function (index, element) {
+ filter(element);
+ });
+ });
+ </script>
+ </body>
+</html>
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/website/learnmore/index.md
----------------------------------------------------------------------
diff --git a/docs/website/learnmore/index.md b/docs/website/learnmore/index.md
index d2a8998..8035e07 100644
--- a/docs/website/learnmore/index.md
+++ b/docs/website/learnmore/index.md
@@ -2,14 +2,27 @@
layout: website-normal
title: Learn More
children:
-# - { path: yaml-explained.md }
+# - yaml-explained.md
- { path: theory.md, title_in_menu: Theory }
+- catalog/
---
<!--
TODO have a list of resources here? or start w yaml explained?
-TODO include { path: catalog/index.html }
+What's a blueprint (image showing yaml with hovers for detail)
+Intro video (2m video)
+Features list (cf http://help.eclipse.org/juno/index.jsp?topic=%2Forg.eclipse.platform.doc.user%2FwhatsNew%2Fplatform_whatsnew.html -- though maybe with smaller screenshots at left and bigger text for summary!)
+Supported software, clouds, and policies
+The Theory
+(based on existing top-level content;
+introduction, core entities, glossary (maybe))
+News
+infoq - http://www.infoq.com/news/2014/06/clocker
+Adam Davis: The case for application-driven cloud computing (Gluecon keynote) http://www.cloudsoftcorp.com/blog/2014/06/adam-davis-case-application-driven-cloud-computing/
+[showing video at min 14]
+FAQ (in time)
+
-->
{% include list-children.html %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/08420058/docs/website/meta/versions.md
----------------------------------------------------------------------
diff --git a/docs/website/meta/versions.md b/docs/website/meta/versions.md
index caba0f9..5ce3c3f 100644
--- a/docs/website/meta/versions.md
+++ b/docs/website/meta/versions.md
@@ -7,9 +7,9 @@ title: Versions
The current stable version of Brooklyn is {{ site.brooklyn-stable-version }}:
-* [Download]({{ site.path.website }}/download.md)
+* [Download]({{ site.path.website }}/download/)
* [User Guide]({{ site.path.guide }}/)
-* [Release Notes]({{ site.path.guide }}/start/release-notes.md)
+* [Release Notes]({{ site.path.guide }}/misc/release-notes.html)
This documentation was generated {{ site.time | date_to_string }}.