docs code cleanup refactoring side menu, deleting "guide" layouts and replacing usages with website layout
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/e424b743 Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/e424b743 Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/e424b743 Branch: refs/heads/master Commit: e424b743fd4463a24816dbdfabbe8cc881b9d169 Parents: d70fc1f Author: Alex Heneveld <[email protected]> Authored: Mon Jan 12 14:49:51 2015 +0000 Committer: Alex Heneveld <[email protected]> Committed: Tue Jan 13 15:36:30 2015 +0000 ---------------------------------------------------------------------- docs/README.md | 28 +-- docs/_build/tests/jsonball/test_jsonball.md | 2 +- .../big_examples/global-web-fabric/index.md | 2 +- docs/_extra/big_examples/index.md | 2 +- docs/_extra/big_examples/messaging/index.md | 2 +- .../big_examples/nosql-cassandra/index.md | 2 +- docs/_extra/big_examples/simple-web-cluster.md | 2 +- docs/_extra/big_examples/webcluster.md | 2 +- docs/_extra/big_examples/webcluster/index.md | 2 +- docs/_extra/list-of-blueprints.md | 2 +- docs/_extra/local-artifact-repo.md | 2 +- docs/_extra/meta/contact.md | 2 +- docs/_extra/meta/irc.md | 2 +- docs/_extra/meta/versions.md | 2 +- docs/_extra/release.md | 2 +- docs/_extra/simple_java_examples/examples.md | 2 +- docs/_extra/standards.md | 2 +- docs/_extra/update-docs.md | 2 +- docs/_includes/breadcrumbs.html | 71 ------- docs/_includes/sidemenu.html | 161 ++++++++++++++++ docs/_layouts/guide-base.html | 183 ------------------- docs/_layouts/guide-old.html | 65 ------- docs/_layouts/website-normal.html | 160 +--------------- docs/guide/concepts/advanced-concepts.md | 2 +- .../concepts/application-parent-membership.md | 2 +- .../concepts/configuration-sensor-effectors.md | 2 +- docs/guide/concepts/dependent-configuration.md | 2 +- docs/guide/concepts/entities.md | 2 +- docs/guide/concepts/execution.md | 2 +- .../concepts/lifecycle-managementcontext.md | 2 +- docs/guide/concepts/location.md | 2 +- docs/guide/concepts/policies.md | 2 +- docs/guide/dev/code/tests.md | 2 +- docs/guide/dev/env/ide/index.md | 2 +- docs/guide/dev/env/maven-build.md | 2 +- .../guide/dev/tips/debugging-remote-brooklyn.md | 2 +- docs/guide/dev/tips/index.md | 2 +- docs/guide/java/archetype.md | 2 +- docs/guide/java/common-usage.md | 4 +- docs/guide/java/defining-and-deploying.md | 2 +- docs/guide/java/entities.md | 2 +- docs/guide/java/entity.md | 2 +- docs/guide/java/policies.md | 2 +- docs/guide/java/policy.md | 2 +- docs/guide/java/service-state.md | 2 +- ...topology-dependencies-management-policies.md | 2 +- docs/guide/misc/download.md | 2 +- docs/guide/misc/javadoc/index.md | 2 +- docs/guide/misc/known-issues.md | 2 +- docs/guide/misc/release-notes.md | 2 +- docs/guide/ops/locations/configuring.md | 2 +- docs/guide/ops/locations/index.md | 2 +- docs/guide/ops/persistence/index.md | 2 +- docs/guide/ops/webconsole/index.md | 2 +- docs/guide/start/blueprints.md | 2 +- docs/guide/start/config.md | 2 +- docs/guide/start/index.md | 2 +- docs/guide/start/managing.md | 2 +- docs/guide/start/policies.md | 2 +- docs/guide/start/running.md | 2 +- docs/guide/yaml/catalog-maintenance.md | 2 +- docs/guide/yaml/chef/about-chef.md | 2 +- .../yaml/chef/advanced-chef-integration.md | 2 +- docs/guide/yaml/chef/creating-blueprints.md | 2 +- docs/guide/yaml/chef/writing-chef.md | 2 +- docs/guide/yaml/clusters-and-policies.md | 2 +- docs/guide/yaml/clusters.md | 2 +- docs/guide/yaml/configuring-vms.md | 2 +- docs/guide/yaml/creating-yaml.md | 15 +- docs/guide/yaml/custom-entities.md | 2 +- docs/guide/yaml/multiple-services.md | 2 +- docs/guide/yaml/mutlitple-services.md | 2 +- docs/guide/yaml/setting-locations.md | 2 +- 73 files changed, 245 insertions(+), 572 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/README.md ---------------------------------------------------------------------- diff --git a/docs/README.md b/docs/README.md index cfac91c..c2fb5e7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -262,34 +262,16 @@ We use some custom Jekyll plugins, in the `_plugins` dir: * include markdown files inside other files (see, for example, the `*.include.md` files which contain text which is used in multiple other files) -* parse JSON which we can loop over in our markdown docs (to do the TOC in the `guide`) -* generate the site structure (for the `website`) +* generate the site structure / menu objects +* parse JSON which we can loop over in our markdown docs (to build up models; previously used + for the TOC in the guide, but now replaced with site_structure) * trim whitespace of ends of variables -# Guide ToC - -In the `guide`, JSON table-of-contents files (toc.json) are our lightweight solution to the -problem of making the site structure navigable (the menus at left). -If you add a page, simply add the file and a title to the `toc.json` in that directory -and it will get included in the menu. - -You can also configure a special toc to show on your page, if you wish, by setting the toc variable in the header. -Most pages declare the `guide-normal` layout (in `_layouts/`) which builds a menu in the left side-bar -(`_includes/sidebar.html`) using the JSON, automatically detecting which page is active. - - -# Website ToC - -The `website` follows a different, simpler pattern, using the `site-structure` plugin -and front-matter in each page. When adding a page, simply add the relevant front matter -in the page(s) which refer to them. - - # Versions Archived versions are kept under `/v/` in the website. New versions should be added with -the appropriate directory (`guide-version` above will do this). These versions take their -own copy of the `style` files so that changes there will not affect future versions. +the appropriate directory (`_build/build.sh guide-version` above will do this). +These versions take their own copy of the `style` files so that changes there will not affect future versions. A list of available versions is in `website/meta/versions.md`. http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/_build/tests/jsonball/test_jsonball.md ---------------------------------------------------------------------- diff --git a/docs/_build/tests/jsonball/test_jsonball.md b/docs/_build/tests/jsonball/test_jsonball.md index ba66858..1dcc572 100644 --- a/docs/_build/tests/jsonball/test_jsonball.md +++ b/docs/_build/tests/jsonball/test_jsonball.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Test Jsonball --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/_extra/big_examples/global-web-fabric/index.md ---------------------------------------------------------------------- diff --git a/docs/_extra/big_examples/global-web-fabric/index.md b/docs/_extra/big_examples/global-web-fabric/index.md index b59eae0..37c7bf6 100644 --- a/docs/_extra/big_examples/global-web-fabric/index.md +++ b/docs/_extra/big_examples/global-web-fabric/index.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Global Web Fabric toc: /guide/toc.json --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/_extra/big_examples/index.md ---------------------------------------------------------------------- diff --git a/docs/_extra/big_examples/index.md b/docs/_extra/big_examples/index.md index f55643f..b5789a3 100644 --- a/docs/_extra/big_examples/index.md +++ b/docs/_extra/big_examples/index.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Examples toc: /guide/toc.json --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/_extra/big_examples/messaging/index.md ---------------------------------------------------------------------- diff --git a/docs/_extra/big_examples/messaging/index.md b/docs/_extra/big_examples/messaging/index.md index c3c2254..f33cecc 100644 --- a/docs/_extra/big_examples/messaging/index.md +++ b/docs/_extra/big_examples/messaging/index.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Publish-Subscribe Messagiung toc: /guide/toc.json --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/_extra/big_examples/nosql-cassandra/index.md ---------------------------------------------------------------------- diff --git a/docs/_extra/big_examples/nosql-cassandra/index.md b/docs/_extra/big_examples/nosql-cassandra/index.md index 88c1dce..7e7948e 100644 --- a/docs/_extra/big_examples/nosql-cassandra/index.md +++ b/docs/_extra/big_examples/nosql-cassandra/index.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Cassandra Clusters toc: /guide/toc.json --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/_extra/big_examples/simple-web-cluster.md ---------------------------------------------------------------------- diff --git a/docs/_extra/big_examples/simple-web-cluster.md b/docs/_extra/big_examples/simple-web-cluster.md index cd2b659..2b08a37 100644 --- a/docs/_extra/big_examples/simple-web-cluster.md +++ b/docs/_extra/big_examples/simple-web-cluster.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Elastic Web Cluster toc: /guide/toc.json --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/_extra/big_examples/webcluster.md ---------------------------------------------------------------------- diff --git a/docs/_extra/big_examples/webcluster.md b/docs/_extra/big_examples/webcluster.md index cd2b659..2b08a37 100644 --- a/docs/_extra/big_examples/webcluster.md +++ b/docs/_extra/big_examples/webcluster.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Elastic Web Cluster toc: /guide/toc.json --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/_extra/big_examples/webcluster/index.md ---------------------------------------------------------------------- diff --git a/docs/_extra/big_examples/webcluster/index.md b/docs/_extra/big_examples/webcluster/index.md index 1fd80dd..99c6b36 100644 --- a/docs/_extra/big_examples/webcluster/index.md +++ b/docs/_extra/big_examples/webcluster/index.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Elastic Web Cluster toc: /guide/toc.json --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/_extra/list-of-blueprints.md ---------------------------------------------------------------------- diff --git a/docs/_extra/list-of-blueprints.md b/docs/_extra/list-of-blueprints.md index 7136dd1..95a602c 100644 --- a/docs/_extra/list-of-blueprints.md +++ b/docs/_extra/list-of-blueprints.md @@ -1,6 +1,6 @@ --- title: Systems Available Out-of-the-Box -layout: guide-normal +layout: website-normal toc: ../guide_toc.json categories: [use, guide] --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/_extra/local-artifact-repo.md ---------------------------------------------------------------------- diff --git a/docs/_extra/local-artifact-repo.md b/docs/_extra/local-artifact-repo.md index 455a545..2fd777b 100644 --- a/docs/_extra/local-artifact-repo.md +++ b/docs/_extra/local-artifact-repo.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Prepopulating a Local Artifact Repository toc: /guide/toc.json --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/_extra/meta/contact.md ---------------------------------------------------------------------- diff --git a/docs/_extra/meta/contact.md b/docs/_extra/meta/contact.md index c318a1f..83de32f 100644 --- a/docs/_extra/meta/contact.md +++ b/docs/_extra/meta/contact.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Contact toc: /guide/toc.json --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/_extra/meta/irc.md ---------------------------------------------------------------------- diff --git a/docs/_extra/meta/irc.md b/docs/_extra/meta/irc.md index 9324bd2..2cc5b97 100644 --- a/docs/_extra/meta/irc.md +++ b/docs/_extra/meta/irc.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: IRC toc: /guide/toc.json --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/_extra/meta/versions.md ---------------------------------------------------------------------- diff --git a/docs/_extra/meta/versions.md b/docs/_extra/meta/versions.md index 57e64a4..aeea4ef 100644 --- a/docs/_extra/meta/versions.md +++ b/docs/_extra/meta/versions.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Versions toc: /guide/toc.json --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/_extra/release.md ---------------------------------------------------------------------- diff --git a/docs/_extra/release.md b/docs/_extra/release.md index 66f730b..656412c 100644 --- a/docs/_extra/release.md +++ b/docs/_extra/release.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Release Process toc: /guide/toc.json --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/_extra/simple_java_examples/examples.md ---------------------------------------------------------------------- diff --git a/docs/_extra/simple_java_examples/examples.md b/docs/_extra/simple_java_examples/examples.md index 330b6d3..2063a3f 100644 --- a/docs/_extra/simple_java_examples/examples.md +++ b/docs/_extra/simple_java_examples/examples.md @@ -1,6 +1,6 @@ --- title: Examples -layout: guide-normal +layout: website-normal toc: ../guide_toc.json categories: [use, guide, defining-applications] --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/_extra/standards.md ---------------------------------------------------------------------- diff --git a/docs/_extra/standards.md b/docs/_extra/standards.md index 66b77b0..ab6a2e3 100644 --- a/docs/_extra/standards.md +++ b/docs/_extra/standards.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Code Standards toc: /guide/toc.json --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/_extra/update-docs.md ---------------------------------------------------------------------- diff --git a/docs/_extra/update-docs.md b/docs/_extra/update-docs.md index ccb573e..5abb056 100644 --- a/docs/_extra/update-docs.md +++ b/docs/_extra/update-docs.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Updating the Docs toc: /guide/toc.json --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/_includes/breadcrumbs.html ---------------------------------------------------------------------- diff --git a/docs/_includes/breadcrumbs.html b/docs/_includes/breadcrumbs.html deleted file mode 100644 index d3bcbea..0000000 --- a/docs/_includes/breadcrumbs.html +++ /dev/null @@ -1,71 +0,0 @@ - -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - -{% if page.toc %} - {% assign p = page.toc %} -{% else %} - {% assign p = 'toc.json' %} -{% endif %} -{% capture toc_string %}{% readj p %}{% endcapture %} -{% jsonball toc from var toc_string %} - -{% capture pagesiteurl %}{{ page.url }}{% endcapture %} - -{% for x in toc %} - {% if pagesiteurl == x.file %} - {% capture l1name %}{{ x.title }}{% endcapture %} - {% capture l1link %}{{ x.file }}{% endcapture %} - {% endif %} - {% if x.children %}{% for x2 in x.children %} - {% if pagesiteurl == x2.file %} - {% capture l1name %}{{ x.title }}{% endcapture %} - {% capture l1link %}{{ x.file }}{% endcapture %} - {% capture l2name %}{{ x2.title }}{% endcapture %} - {% capture l2link %}{{ x2.file }}{% endcapture %} - {% endif %} - {% if x2.children %}{% for x3 in x2.children %} - {% if pagesiteurl == x3.file %} - {% capture l1name %}{{ x.title }}{% endcapture %} - {% capture l1link %}{{ x.file }}{% endcapture %} - {% capture l2name %}{{ x2.title }}{% endcapture %} - {% capture l2link %}{{ x2.file }}{% endcapture %} - {% capture l3name %}{{ x3.title }}{% endcapture %} - {% capture l3link %}{{ x3.file }}{% endcapture %} - {% endif %} - {% endfor %}{% endif %} - {% endfor %}{% endif %} -{% endfor %} - -{% if l1name %}{% else %} - {% capture l1name %}Home{% endcapture %} - {% capture l1link %}{{ site.todo_page }}{% endcapture %} - {% capture l2name %}{{ page.title }}{% endcapture %} - {% capture l2link %}{{ pagesiteurl }}{% endcapture %} -{% endif %} - -<p id="breadcrumb"> - <a href="{{l1link}}">{{ l1name }}</a> - {% if l2name %} - » <a href="{{l2link}}">{{l2name}}</a> - {% if l3name %} - » <a href="{{l3link}}">{{l3name}}</a> - {% endif %} - {% endif %} -</p> http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/_includes/sidemenu.html ---------------------------------------------------------------------- diff --git a/docs/_includes/sidemenu.html b/docs/_includes/sidemenu.html new file mode 100644 index 0000000..4b67287 --- /dev/null +++ b/docs/_includes/sidemenu.html @@ -0,0 +1,161 @@ +<div class="list-group side-menu" id="side-menu"> +{% comment %} + + Case 1) If we're the landing page show nothing. + Case 2) If we're contained in the top (landing page) menu, show our menu if we have one. + Case 3a) Otherwise if we're contained in a menu, show that menu. + Case 3b) And if we have a menu, show our menu nested. + + Note the breadcrumbs are offset:1. This is because usually breadcrumbs include the root; + but also if we're overriding breadcrumbs it gives us a way to set a topmenu item (making it breadcrumb[0]) + while customizing the side menu (make self breadcrumb[1]). +{% endcomment %} + +{% unless page.landing %} + {% if page.menu_parent %} + {% if page.menu_parent.landing %} {% comment %} case 2 {% endcomment %} + {% for item in page.breadcrumb_pages offset:1 %} + <h4 class="{% if forloop.index0 > 0 %} with_preceding{% endif %}{% if forloop.rindex0 > 0 %} with_following{% endif %}"> + <a href="{{item.url}}" class="list-group-item{% if item.path == page.menu_path %} active{% endif %} breadcrumb breadcrumb{{ forloop.index0 }}"> + {{ item.title_in_menu }}</a></h4> + {% endfor %} + {% for item in page.menu %} + <a href="{{item.url}}" class="list-group-item{% if page.breadcrumbs contains item %} active{% endif %}">{{ item.title_in_menu }}</a> + {% endfor %} + + {% else %} {% comment %} case 3a {% endcomment %} + {% for item in page.menu_parent.breadcrumb_pages offset:1 %} + <h4 class="{% if forloop.index0 > 0 %} with_preceding{% endif %}{% if forloop.rindex0 > 0 %} with_following{% endif %}"> + <a href="{{item.url}}" class="list-group-item{% if item.path == page.menu_path %}{% unless item.menu_customization.force_inactive %} active{% endunless %}{% endif %} breadcrumb breadcrumb{{ forloop.index0 }}"> + {{ item.title_in_menu }}</a></h4> + {% endfor %} + {% for item in page.menu_parent.menu %} + {% if (page.breadcrumb_paths contains item.menu_path) and page.menu %} + {% comment %} case 3b {% endcomment %} + <a href="{{item.url}}" class="list-group-item active with-sub-item">{{ item.title_in_menu }}</a> + <div class="sub-item"> + {% for item2 in page.menu %} + {% capture item_section_classes %}{% if item2.section %} section{% endif %}{% endcapture %} + <a href="{{item2.url}}" class="list-group-item sub-item {{ item_section_classes }}" {% if item2.section %}section-target="#{{ item2.section }}"{% endif %}> + {{ item2.title_in_menu }}</a> + {% endfor %} + </div> + {% else %} + {% comment %} case 3a side menu item {% endcomment %} + <a href="{{item.url}}" class="list-group-item{% if page.breadcrumb_paths contains item.menu_path %}{% unless item.menu_customization.force_inactive %} active{% endunless %}{% endif %}">{{ item.title_in_menu }}</a> + {% endif %} + {% endfor %} + + {% endif %} + {% elsif page.menu %} + <!-- no pages have a menu without being in the top menu, won't come here --> + {% endif %} +{% endunless %} + +</div> +<div id="width_reference"></div> + + +<script language="JavaScript" type="application/javascript"> + +{% comment %} +the menu is css position:fixed so won't scroll; +but also it will not obey its parents width. +set the width on load and on resize. +{% endcomment %} +sidemenu_x_sizer=function(){ $('#side-menu').width($('#side-menu').parent().find('#width_reference').outerWidth()); }; +$(sidemenu_x_sizer); +$(window).resize(sidemenu_x_sizer); + +{% comment %} +also ensure the y-height of the screen is big enough, else revert to non-floating menu +{% endcomment %} +sidemenu_y_nonfloater=function(){ + if ($('#side-menu').outerHeight(true) + $('#header').outerHeight(true) + $('#footer').outerHeight(true) > window.innerHeight) { + $('#side-menu').css('position', 'inherit'); + } else { + // restore if screen has grown + $('#side-menu').css('position', 'fixed'); + } +}; +$(sidemenu_y_nonfloater); +$(window).resize(sidemenu_y_nonfloater); + + +// Cache selectors +var sideMenu = $("#side-menu"), + sideItems = sideMenu.find("a"), + // Anchors corresponding to menu items + scrollItems = sideItems.map(function(){ + var item = $(this).attr("section-target"); + if (item && item.length) { return item; } + }); + +var highlight_section_last_top = -1; + +var highlight_section = function(data) { + // Get container scroll position + var highlight_section_new_top = $(this).scrollTop(); + if (highlight_section_new_top == highlight_section_last_top) return; + var highlight_section_new_bottom = highlight_section_new_top + $(window).height(); + var scroll_advancing = (highlight_section_new_top > highlight_section_last_top); + + // if initial, look if there was a link supplied + + // if scrolling advance, pick up a section when title is fully visible + + // if scrolling back, pick up a section as soon as the title is visible, + // of if the next title is below the halfway point + + // when scrolling up + // Get id of all scroll items above the current position + var last_item = null, active_item = $("#side-menu a.section#active"); + var cur = scrollItems.map(function(itemI){ + item = $(scrollItems[itemI]); + if (item && item.length) { + if (scroll_advancing) { + // if scrolling advance, pick up a section when title starts before 1/3 height + if (item.offset().top < highlight_section_new_top + $(window).height()/3) + return item; + + // or if containing div is finished (usu the whole main content) + div_containing_item = item.closest("div"); + if (div_containing_item.offset().top + div_containing_item.height() < highlight_section_new_bottom + 15) + return item; + // or when next title is visible + if (last_item && item.offset().top < highlight_section_new_bottom + 15) + return last_item; + } else { + // if scrolling back, pick up a section as soon as the title is visible, + if (item.offset().top < highlight_section_new_top) + return item; + // or if title is before the 2/3 point + // (not sure about this, probably want also to have + // "AND the id.top is <= current_active_it.top" so we don't jump FORWARD a section + // when scrolling BACK, with lots of tiny sections) + if ((item.offset().top < highlight_section_new_top + 2*$(window).height()/3) + && (!active_item || !active_item.offset() || active_item.offset().top >= item.offset().top)) + return item; + + } + last_item = item; + } + }); + // Get the id of the current element + cur = cur[cur.length-1]; + var id = cur && cur.length ? cur[0].id : ""; + // Set/remove active class + new_active = $("#side-menu a.section").filter("[section-target='#"+id+"']"); + if (new_active.hasClass("active")) { + // nothing needed + } else { + $("#side-menu a.section").removeClass("active"); + $("#side-menu a.section").filter("[section-target='#"+id+"']").addClass("active"); + } + + highlight_section_last_top = highlight_section_new_top; +}; + +$(window).scroll(highlight_section); +$(highlight_section); +</script> http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/_layouts/guide-base.html ---------------------------------------------------------------------- diff --git a/docs/_layouts/guide-base.html b/docs/_layouts/guide-base.html deleted file mode 100644 index 3facdb6..0000000 --- a/docs/_layouts/guide-base.html +++ /dev/null @@ -1,183 +0,0 @@ ---- -# Licensed to the Apache Software Foundation (ASF) under one -# or more contributor license agreements. See the NOTICE file -# distributed with this work for additional information -# regarding copyright ownership. The ASF licenses this file -# to you under the Apache License, Version 2.0 (the -# "License"); you may not use this file except in compliance -# with the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -layout: base ---- - -<head> - - {% include base-head.html %} - - <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" /> - - <script type="text/javascript" src="https://www.google.com/jsapi";></script> - - <!-- Sidebar/ToC Scripts and CSS --> - <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.path.style }}/deps/superfish.js"></script> - <script type="text/javascript" src="{{ site.path.style }}/deps/jquery.cookie.js"></script> - -<!-- Clipboard support --> -<script src="//cdnjs.cloudflare.com/ajax/libs/zeroclipboard/1.3.1/ZeroClipboard.min.js"></script> -<style type="text/css"> -.clipboard_container { float: right; padding: 8px; } -.clipboard_button { - background-image: url("{{ site.path.style }}/img/clipboard-green-normal.png"); - background-size: 18px 21px; - width: 18px; height: 21px; - overflow: auto; -} -.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' }); -</script> -<script type="text/javascript"> <!-- clipboard positioning --> -$(document).ready(function() { - $('<div class="clipboard_container" title="Copy to Clipboard">'+ - '<div class="clipboard_button"/>'+ - '</div>').insertBefore($('div.highlight')) - $('div.clipboard_container').each(function(index) { - var clipboard = new ZeroClipboard(); - clipboard.clip( $(this).find(":first")[0], $(this)[0] ); - var target = $(this).next(); - var txt = target.text().trim(); - if (target.find('code.bash')) { - // Strip out bash prompts from the start of each line (i.e. '$' or '%' characters - // at the very start, or immediately following any newline). Correctly handles continuation - // lines, where a leading '$' or '%' is *not* a prompt character. - txt = txt.replace(/(^|[^\\]\n)[$%] /g, "$1"); - } - clipboard.on( 'dataRequested', function (client, args) { - client.setText( txt ); - }); - }); -}); -</script> - - <script type="text/javascript"> - // initialise menu delay - $(document).ready(function() { - $('ul#mainmenu').superfish({ - autoArrows: false, // disable generation of arrow mark-up - dropShadows: false, // disable drop shadows - disableHI: true, // set to true to disable hoverIntent detection - delay: 500, // the delay in milliseconds that the mouse can remain outside a submenu without it closing - speed: 'fast', - }); - }); - </script> - -<script type="text/javascript"> - -<!-- search --> - $(function() { - $('#simple_google') - .submit(function() { - $('input[name="q"]').val("site:" + document.location.hostname + " " + $('input[name="brooklyn-search"]').val()); - return true; - }); - $('input[name="brooklyn-search"]').focus(function() { - if ($(this).val() === $(this).attr('placeholder')) { - $(this).val(''); - } - }) - .blur(function() { - if ($(this).val() === '') { - $(this).val($(this).attr('placeholder')); - } - }) - .blur(); - }); - -<!-- page notes --> - $(function() { - if (document.location.pathname.replace(/^\/([^\/]*).*$/, '$1') === "v"){ - var thisversion = document.location.pathname.split("/")[2], - msg = ""; - - if (thisversion != 'latest' && !$.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.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'>"; - msg += "<a href = '#' onclick=\"set_user_version('"+thisversion+"');\">Yes, hide this warning</a>"; - msg += "<a href = '{{ site.page.guide }}'>No, show me the latest version</a>"; - msg += "<a href = '{{ site.page.guide }}/meta/versions.html'>Show all versions</a>"; - msg += "</p>" - - $('#page_notes').html(msg); - $('#page_notes').fadeIn('slow'); - } - } - }); - function get_user_versions() { - return $.cookie("brooklyn_versions") ? $.cookie("brooklyn_versions").split(",") : []; - }; - function set_user_version(version) { - var version_cookie = get_user_versions(); - version_cookie.push(version); - $.cookie('brooklyn_versions', version_cookie, { expires: 365, path: '/' }); - $('#page_notes').fadeOut(); - event.preventDefault ? event.preventDefault() : event.returnValue = false; - }; - function set_user_versions_all() { - var version_cookie = get_user_versions(); - version_cookie.push("ALL"); - $.cookie('brooklyn_versions', version_cookie, { expires: 365, path: '/' }); - $('#page_notes').fadeOut(); - event.preventDefault ? event.preventDefault() : event.returnValue = false; - }; - function clear_user_versions() { - $.removeCookie('brooklyn_versions', { path: '/' }); - $('#page_notes').fadeIn('slow'); - event.preventDefault ? event.preventDefault() : event.returnValue = false; - }; - - - <!-- analytics --> - var _gaq = _gaq || []; - _gaq.push(['_setAccount', 'UA-30530918-1']); - _gaq.push(['_trackPageview']); - - (function() { - var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; - ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); - })(); -</script> - -</head> - -<body> - - <ul id="shortcuts" title="Accessibility shortcuts menu"> - <li><a href="#maincontent">Skip to main content</a></li> - </ul> - - -{{ content }} - - -</body> http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/_layouts/guide-old.html ---------------------------------------------------------------------- diff --git a/docs/_layouts/guide-old.html b/docs/_layouts/guide-old.html deleted file mode 100644 index 736c838..0000000 --- a/docs/_layouts/guide-old.html +++ /dev/null @@ -1,65 +0,0 @@ ---- -# Licensed to the Apache Software Foundation (ASF) under one -# or more contributor license agreements. See the NOTICE file -# distributed with this work for additional information -# regarding copyright ownership. The ASF licenses this file -# to you under the Apache License, Version 2.0 (the -# "License"); you may not use this file except in compliance -# with the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -layout: guide-base ---- - -{% include topmenu.html %} - -<div id="container"> - - <div id="header"> - - <div id="menubar"> - -{% include topbar.html %} - - <form method="get" id="simple_google" class="searchform" action="http://www.google.com/search"; method="get"> - <input type="text" class="searchinput" name="brooklyn-search" placeholder=" Search: type & hit enter" /> - <input type="hidden" name="q" value="" /> - </form> - - </div> - - </div><!--header--> - - <div id="contentcontainer"> - - <div id="maincontent"> - -{% include breadcrumbs.html %} - -<div id="page_notes"></div> - -<h1 id="header_title">{{ page.title }}</h1> - -{{ content }} - - </div><!--maincontent--> - - <div id="sidebar"> - -{% include sidebar.html %} - - </div> - - </div><!--contentcontainer--> - -</div><!--container--> - -{% include footer.html %} http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/_layouts/website-normal.html ---------------------------------------------------------------------- diff --git a/docs/_layouts/website-normal.html b/docs/_layouts/website-normal.html index 91272b3..3a7e9b9 100644 --- a/docs/_layouts/website-normal.html +++ b/docs/_layouts/website-normal.html @@ -30,167 +30,9 @@ layout: website-base </div> <div class="col-md-3"> -<script language="JavaScript" type="application/javascript"> -{% comment %} -the menu is css position:fixed so won't scroll; -but also it will not obey its parents width. -set the width on load and on resize. -{% endcomment %} -sidemenu_x_sizer=function(){ $('#side-menu').width($('#side-menu').parent().find('#width_reference').outerWidth()); }; -$(sidemenu_x_sizer); -$(window).resize(sidemenu_x_sizer); - -{% comment %} -also ensure the y-height of the screen is big enough, else revert to non-floating menu -{% endcomment %} -sidemenu_y_nonfloater=function(){ - if ($('#side-menu').outerHeight(true) + $('#header').outerHeight(true) + $('#footer').outerHeight(true) > window.innerHeight) { - $('#side-menu').css('position', 'inherit'); - } else { - // restore if screen has grown - $('#side-menu').css('position', 'fixed'); - } -}; -$(sidemenu_y_nonfloater); -$(window).resize(sidemenu_y_nonfloater); -</script> - <div class="list-group side-menu" id="side-menu"> -{% comment %} - - Case 1) If we're the landing page show nothing. - Case 2) If we're contained in the top (landing page) menu, show our menu if we have one. - Case 3a) Otherwise if we're contained in a menu, show that menu. - Case 3b) And if we have a menu, show our menu nested. - - Note the breadcrumbs are offset:1. This is because usually breadcrumbs include the root; - but also if we're overriding breadcrumbs it gives us a way to set a topmenu item (making it breadcrumb[0]) - while customizing the side menu (make self breadcrumb[1]). -{% endcomment %} - -{% unless page.landing %} - {% if page.menu_parent %} - {% if page.menu_parent.landing %} {% comment %} case 2 {% endcomment %} - {% for item in page.breadcrumb_pages offset:1 %} - <h4 class="{% if forloop.index0 > 0 %} with_preceding{% endif %}{% if forloop.rindex0 > 0 %} with_following{% endif %}"> - <a href="{{item.url}}" class="list-group-item{% if item.path == page.menu_path %} active{% endif %} breadcrumb breadcrumb{{ forloop.index0 }}"> - {{ item.title_in_menu }}</a></h4> - {% endfor %} - {% for item in page.menu %} - <a href="{{item.url}}" class="list-group-item{% if page.breadcrumbs contains item %} active{% endif %}">{{ item.title_in_menu }}</a> - {% endfor %} - - {% else %} {% comment %} case 3a {% endcomment %} - {% for item in page.menu_parent.breadcrumb_pages offset:1 %} - <h4 class="{% if forloop.index0 > 0 %} with_preceding{% endif %}{% if forloop.rindex0 > 0 %} with_following{% endif %}"> - <a href="{{item.url}}" class="list-group-item{% if item.path == page.menu_path %}{% unless item.menu_customization.force_inactive %} active{% endunless %}{% endif %} breadcrumb breadcrumb{{ forloop.index0 }}"> - {{ item.title_in_menu }}</a></h4> - {% endfor %} - {% for item in page.menu_parent.menu %} - {% if (page.breadcrumb_paths contains item.menu_path) and page.menu %} - {% comment %} case 3b {% endcomment %} - <a href="{{item.url}}" class="list-group-item active with-sub-item">{{ item.title_in_menu }}</a> - <div class="sub-item"> - {% for item2 in page.menu %} - {% capture item_section_classes %}{% if item2.section %} section{% endif %}{% endcapture %} - <a href="{{item2.url}}" class="list-group-item sub-item {{ item_section_classes }}" {% if item2.section %}section-target="#{{ item2.section }}"{% endif %}> - {{ item2.title_in_menu }}</a> - {% endfor %} - </div> - {% else %} - {% comment %} case 3a side menu item {% endcomment %} - <a href="{{item.url}}" class="list-group-item{% if page.breadcrumb_paths contains item.menu_path %}{% unless item.menu_customization.force_inactive %} active{% endunless %}{% endif %}">{{ item.title_in_menu }}</a> - {% endif %} - {% endfor %} - - {% endif %} - {% elsif page.menu %} - <!-- no pages have a menu without being in the top menu, won't come here --> - {% endif %} -{% endunless %} - - </div> - <div id="width_reference"></div> + {% include sidemenu.html %} </div> </div> </div> -<script language="JavaScript" type="application/javascript"> -// Cache selectors -var sideMenu = $("#side-menu"), - sideItems = sideMenu.find("a"), - // Anchors corresponding to menu items - scrollItems = sideItems.map(function(){ - var item = $(this).attr("section-target"); - if (item && item.length) { return item; } - }); - -var highlight_section_last_top = -1; - -var highlight_section = function(data) { - // Get container scroll position - var highlight_section_new_top = $(this).scrollTop(); - if (highlight_section_new_top == highlight_section_last_top) return; - var highlight_section_new_bottom = highlight_section_new_top + $(window).height(); - var scroll_advancing = (highlight_section_new_top > highlight_section_last_top); - - // if initial, look if there was a link supplied - - // if scrolling advance, pick up a section when title is fully visible - - // if scrolling back, pick up a section as soon as the title is visible, - // of if the next title is below the halfway point - - // when scrolling up - // Get id of all scroll items above the current position - var last_item = null, active_item = $("#side-menu a.section#active"); - var cur = scrollItems.map(function(itemI){ - item = $(scrollItems[itemI]); - if (item && item.length) { - if (scroll_advancing) { - // if scrolling advance, pick up a section when title starts before 1/3 height - if (item.offset().top < highlight_section_new_top + $(window).height()/3) - return item; - - // or if containing div is finished (usu the whole main content) - div_containing_item = item.closest("div"); - if (div_containing_item.offset().top + div_containing_item.height() < highlight_section_new_bottom + 15) - return item; - // or when next title is visible - if (last_item && item.offset().top < highlight_section_new_bottom + 15) - return last_item; - } else { - // if scrolling back, pick up a section as soon as the title is visible, - if (item.offset().top < highlight_section_new_top) - return item; - // or if title is before the 2/3 point - // (not sure about this, probably want also to have - // "AND the id.top is <= current_active_it.top" so we don't jump FORWARD a section - // when scrolling BACK, with lots of tiny sections) - if ((item.offset().top < highlight_section_new_top + 2*$(window).height()/3) - && (!active_item || !active_item.offset() || active_item.offset().top >= item.offset().top)) - return item; - - } - last_item = item; - } - }); - // Get the id of the current element - cur = cur[cur.length-1]; - var id = cur && cur.length ? cur[0].id : ""; - // Set/remove active class - new_active = $("#side-menu a.section").filter("[section-target='#"+id+"']"); - if (new_active.hasClass("active")) { - // nothing needed - } else { - $("#side-menu a.section").removeClass("active"); - $("#side-menu a.section").filter("[section-target='#"+id+"']").addClass("active"); - } - - highlight_section_last_top = highlight_section_new_top; -}; - -$(window).scroll(highlight_section); -$(highlight_section); -</script> - {% include footer.html %} http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/concepts/advanced-concepts.md ---------------------------------------------------------------------- diff --git a/docs/guide/concepts/advanced-concepts.md b/docs/guide/concepts/advanced-concepts.md index 1b36170..13e791d 100644 --- a/docs/guide/concepts/advanced-concepts.md +++ b/docs/guide/concepts/advanced-concepts.md @@ -1,6 +1,6 @@ --- title: Advanced Concepts -layout: guide-normal +layout: website-normal toc: ../guide_toc.json categories: [use, guide, defining-applications] --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/concepts/application-parent-membership.md ---------------------------------------------------------------------- diff --git a/docs/guide/concepts/application-parent-membership.md b/docs/guide/concepts/application-parent-membership.md index 18f1a54..c2d0ac3 100644 --- a/docs/guide/concepts/application-parent-membership.md +++ b/docs/guide/concepts/application-parent-membership.md @@ -1,6 +1,6 @@ --- title: Application, Parent and Membership -layout: guide-normal +layout: website-normal toc: ../guide_toc.json categories: [use, guide, defining-applications] --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/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 47ec72e..72e4e93 100644 --- a/docs/guide/concepts/configuration-sensor-effectors.md +++ b/docs/guide/concepts/configuration-sensor-effectors.md @@ -1,6 +1,6 @@ --- title: Configuration, Sensors and Effectors -layout: guide-normal +layout: website-normal toc: ../guide_toc.json categories: [use, guide, defining-applications] --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/concepts/dependent-configuration.md ---------------------------------------------------------------------- diff --git a/docs/guide/concepts/dependent-configuration.md b/docs/guide/concepts/dependent-configuration.md index 0ed60ff..1d08e1a 100644 --- a/docs/guide/concepts/dependent-configuration.md +++ b/docs/guide/concepts/dependent-configuration.md @@ -1,6 +1,6 @@ --- title: Dependent Configuration -layout: guide-normal +layout: website-normal toc: ../guide_toc.json categories: [use, guide, defining-applications] --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/concepts/entities.md ---------------------------------------------------------------------- diff --git a/docs/guide/concepts/entities.md b/docs/guide/concepts/entities.md index 26981e7..0afeb50 100644 --- a/docs/guide/concepts/entities.md +++ b/docs/guide/concepts/entities.md @@ -1,6 +1,6 @@ --- title: Entities -layout: guide-normal +layout: website-normal toc: ../guide_toc.json categories: [use, guide, defining-applications] --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/concepts/execution.md ---------------------------------------------------------------------- diff --git a/docs/guide/concepts/execution.md b/docs/guide/concepts/execution.md index 4bb4875..f58f738 100644 --- a/docs/guide/concepts/execution.md +++ b/docs/guide/concepts/execution.md @@ -1,6 +1,6 @@ --- title: Execution -layout: guide-normal +layout: website-normal toc: ../guide_toc.json categories: [use, guide, defining-applications] --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/concepts/lifecycle-managementcontext.md ---------------------------------------------------------------------- diff --git a/docs/guide/concepts/lifecycle-managementcontext.md b/docs/guide/concepts/lifecycle-managementcontext.md index 3495e17..84831d1 100644 --- a/docs/guide/concepts/lifecycle-managementcontext.md +++ b/docs/guide/concepts/lifecycle-managementcontext.md @@ -1,6 +1,6 @@ --- title: Lifecycle and ManagementContext -layout: guide-normal +layout: website-normal toc: ../guide_toc.json categories: [use, guide, defining-applications] --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/concepts/location.md ---------------------------------------------------------------------- diff --git a/docs/guide/concepts/location.md b/docs/guide/concepts/location.md index 2a06cac..417d0a7 100644 --- a/docs/guide/concepts/location.md +++ b/docs/guide/concepts/location.md @@ -1,6 +1,6 @@ --- title: Location -layout: guide-normal +layout: website-normal toc: ../guide_toc.json categories: [use, guide, defining-applications] --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/concepts/policies.md ---------------------------------------------------------------------- diff --git a/docs/guide/concepts/policies.md b/docs/guide/concepts/policies.md index ad8c0bb..495e57f 100644 --- a/docs/guide/concepts/policies.md +++ b/docs/guide/concepts/policies.md @@ -1,6 +1,6 @@ --- title: Policies -layout: guide-normal +layout: website-normal toc: ../guide_toc.json categories: [use, guide, defining-applications] --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/dev/code/tests.md ---------------------------------------------------------------------- diff --git a/docs/guide/dev/code/tests.md b/docs/guide/dev/code/tests.md index f202dc2..6d2bbab 100644 --- a/docs/guide/dev/code/tests.md +++ b/docs/guide/dev/code/tests.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Tests toc: /guide/toc.json --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/dev/env/ide/index.md ---------------------------------------------------------------------- diff --git a/docs/guide/dev/env/ide/index.md b/docs/guide/dev/env/ide/index.md index 3abae3c..ac56a18 100644 --- a/docs/guide/dev/env/ide/index.md +++ b/docs/guide/dev/env/ide/index.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: IDE Setup toc: /guide/toc.json --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/dev/env/maven-build.md ---------------------------------------------------------------------- diff --git a/docs/guide/dev/env/maven-build.md b/docs/guide/dev/env/maven-build.md index 90aa6fa..f64970a 100644 --- a/docs/guide/dev/env/maven-build.md +++ b/docs/guide/dev/env/maven-build.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Maven Build toc: /guide/toc.json --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/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 23857e3..0f1677c 100644 --- a/docs/guide/dev/tips/debugging-remote-brooklyn.md +++ b/docs/guide/dev/tips/debugging-remote-brooklyn.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Brooklyn Remote Debugging toc: /guide/toc.json --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/dev/tips/index.md ---------------------------------------------------------------------- diff --git a/docs/guide/dev/tips/index.md b/docs/guide/dev/tips/index.md index 9045fe9..e5e9eda 100644 --- a/docs/guide/dev/tips/index.md +++ b/docs/guide/dev/tips/index.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Miscellaneous Tips and Tricks --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/java/archetype.md ---------------------------------------------------------------------- diff --git a/docs/guide/java/archetype.md b/docs/guide/java/archetype.md index 482e51c..0bbf6f4 100644 --- a/docs/guide/java/archetype.md +++ b/docs/guide/java/archetype.md @@ -1,6 +1,6 @@ --- title: Creating from a Maven Archetype -layout: guide-normal +layout: website-normal toc: ../guide_toc.json categories: [use, guide, defining-applications] --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/java/common-usage.md ---------------------------------------------------------------------- diff --git a/docs/guide/java/common-usage.md b/docs/guide/java/common-usage.md index e3cf54f..3e631a2 100644 --- a/docs/guide/java/common-usage.md +++ b/docs/guide/java/common-usage.md @@ -1,6 +1,6 @@ --- title: Common Classes and Entities -layout: guide-normal +layout: website-normal --- ### Entity Class Hierarchy @@ -39,4 +39,4 @@ These include: - **PaaS**: Cloud Foundry, Stackato; OpenShift -® \ No newline at end of file +® http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/java/defining-and-deploying.md ---------------------------------------------------------------------- diff --git a/docs/guide/java/defining-and-deploying.md b/docs/guide/java/defining-and-deploying.md index 084b4f6..4f05b0b 100644 --- a/docs/guide/java/defining-and-deploying.md +++ b/docs/guide/java/defining-and-deploying.md @@ -1,6 +1,6 @@ --- title: Defining and Deploying -layout: guide-normal +layout: website-normal --- ## Intro http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/java/entities.md ---------------------------------------------------------------------- diff --git a/docs/guide/java/entities.md b/docs/guide/java/entities.md index f529762..aae674d 100644 --- a/docs/guide/java/entities.md +++ b/docs/guide/java/entities.md @@ -1,6 +1,6 @@ --- title: Custom Entity Development -layout: guide-normal +layout: website-normal --- This section details how to create new custom application components or groups as brooklyn entities. http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/java/entity.md ---------------------------------------------------------------------- diff --git a/docs/guide/java/entity.md b/docs/guide/java/entity.md index 6d780be..6828a17 100644 --- a/docs/guide/java/entity.md +++ b/docs/guide/java/entity.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Writing an Entity --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/java/policies.md ---------------------------------------------------------------------- diff --git a/docs/guide/java/policies.md b/docs/guide/java/policies.md index 5bc8289..9457f72 100644 --- a/docs/guide/java/policies.md +++ b/docs/guide/java/policies.md @@ -1,6 +1,6 @@ --- title: Policies -layout: guide-normal +layout: website-normal --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/java/policy.md ---------------------------------------------------------------------- diff --git a/docs/guide/java/policy.md b/docs/guide/java/policy.md index d785f0d..fbb79db 100644 --- a/docs/guide/java/policy.md +++ b/docs/guide/java/policy.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Writing a Policy --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/java/service-state.md ---------------------------------------------------------------------- diff --git a/docs/guide/java/service-state.md b/docs/guide/java/service-state.md index 32212bc..2abbf65 100644 --- a/docs/guide/java/service-state.md +++ b/docs/guide/java/service-state.md @@ -1,6 +1,6 @@ --- title: Service State -layout: guide-normal +layout: website-normal toc: ../guide_toc.json categories: [use, guide, defining-applications] --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/java/topology-dependencies-management-policies.md ---------------------------------------------------------------------- diff --git a/docs/guide/java/topology-dependencies-management-policies.md b/docs/guide/java/topology-dependencies-management-policies.md index 8039d2c..249c99a 100644 --- a/docs/guide/java/topology-dependencies-management-policies.md +++ b/docs/guide/java/topology-dependencies-management-policies.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Topology, Dependencies, and Management Policies title_in_menu: Topology, Dependencies, and Management Policies --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/misc/download.md ---------------------------------------------------------------------- diff --git a/docs/guide/misc/download.md b/docs/guide/misc/download.md index 011d9f3..ff8f469 100644 --- a/docs/guide/misc/download.md +++ b/docs/guide/misc/download.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Downloads --- {% include fields.md %} http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/misc/javadoc/index.md ---------------------------------------------------------------------- diff --git a/docs/guide/misc/javadoc/index.md b/docs/guide/misc/javadoc/index.md index c44b6e3..5cf9ebc 100644 --- a/docs/guide/misc/javadoc/index.md +++ b/docs/guide/misc/javadoc/index.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: API Reference toc: ../../toc.json --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/misc/known-issues.md ---------------------------------------------------------------------- diff --git a/docs/guide/misc/known-issues.md b/docs/guide/misc/known-issues.md index 5514b13..db54a06 100644 --- a/docs/guide/misc/known-issues.md +++ b/docs/guide/misc/known-issues.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Known Issues --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/misc/release-notes.md ---------------------------------------------------------------------- diff --git a/docs/guide/misc/release-notes.md b/docs/guide/misc/release-notes.md index c2f49a2..8683eb8 100644 --- a/docs/guide/misc/release-notes.md +++ b/docs/guide/misc/release-notes.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Release Notes --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/ops/locations/configuring.md ---------------------------------------------------------------------- diff --git a/docs/guide/ops/locations/configuring.md b/docs/guide/ops/locations/configuring.md index 3a02260..cb3ee16 100644 --- a/docs/guide/ops/locations/configuring.md +++ b/docs/guide/ops/locations/configuring.md @@ -1,6 +1,6 @@ --- title: Configuring Locations -layout: guide-normal +layout: website-normal --- <a id="locations"></a> http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/ops/locations/index.md ---------------------------------------------------------------------- diff --git a/docs/guide/ops/locations/index.md b/docs/guide/ops/locations/index.md index 4fc3b98..3d2b99a 100644 --- a/docs/guide/ops/locations/index.md +++ b/docs/guide/ops/locations/index.md @@ -1,6 +1,6 @@ --- title: Locations Intro -layout: guide-normal +layout: website-normal --- Locations are the environments to which Brooklyn deploys applications. http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/ops/persistence/index.md ---------------------------------------------------------------------- diff --git a/docs/guide/ops/persistence/index.md b/docs/guide/ops/persistence/index.md index be19606..819e182 100644 --- a/docs/guide/ops/persistence/index.md +++ b/docs/guide/ops/persistence/index.md @@ -1,6 +1,6 @@ --- title: Persistence -layout: guide-normal +layout: website-normal --- Brooklyn can be configured to persist its state so that the Brooklyn server can be restarted, http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/ops/webconsole/index.md ---------------------------------------------------------------------- diff --git a/docs/guide/ops/webconsole/index.md b/docs/guide/ops/webconsole/index.md index 9764ae9..62afc2c 100644 --- a/docs/guide/ops/webconsole/index.md +++ b/docs/guide/ops/webconsole/index.md @@ -1,6 +1,6 @@ --- title: Runtime Management -layout: guide-normal +layout: website-normal --- brooklyn uses many of the ideas from autonomic computing to implement management of entities in a structured and reusable fashion (including provisioning, http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/start/blueprints.md ---------------------------------------------------------------------- diff --git a/docs/guide/start/blueprints.md b/docs/guide/start/blueprints.md index c6c0bc3..9657d0d 100644 --- a/docs/guide/start/blueprints.md +++ b/docs/guide/start/blueprints.md @@ -1,7 +1,7 @@ --- title: Launching Applications title_in_menu: Launching Applications -layout: guide-normal +layout: website-normal menu_parent: index.md --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/start/config.md ---------------------------------------------------------------------- diff --git a/docs/guide/start/config.md b/docs/guide/start/config.md index 016834d..1fa61be 100644 --- a/docs/guide/start/config.md +++ b/docs/guide/start/config.md @@ -1,7 +1,7 @@ --- title: Configuring Brooklyn title_in_menu: Configuring Brooklyn -layout: guide-normal +layout: website-normal menu_parent: index.md --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/start/index.md ---------------------------------------------------------------------- diff --git a/docs/guide/start/index.md b/docs/guide/start/index.md index 4967dd7..3bc9f92 100644 --- a/docs/guide/start/index.md +++ b/docs/guide/start/index.md @@ -1,5 +1,5 @@ --- -layout: guide-normal +layout: website-normal title: Getting Started menu_parent: ../index.md children: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/start/managing.md ---------------------------------------------------------------------- diff --git a/docs/guide/start/managing.md b/docs/guide/start/managing.md index 44645f7..b36bcaf 100644 --- a/docs/guide/start/managing.md +++ b/docs/guide/start/managing.md @@ -1,7 +1,7 @@ --- title: Monitoring and Managing Applications title_in_menu: Monitoring and Managing Applications -layout: guide-normal +layout: website-normal menu_parent: index.md --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/start/policies.md ---------------------------------------------------------------------- diff --git a/docs/guide/start/policies.md b/docs/guide/start/policies.md index 1b665df..00fdde5 100644 --- a/docs/guide/start/policies.md +++ b/docs/guide/start/policies.md @@ -1,7 +1,7 @@ --- title: Getting Started - Policies title_in_menu: Policies -layout: guide-normal +layout: website-normal --- ### Exploring and Testing Policies http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/start/running.md ---------------------------------------------------------------------- diff --git a/docs/guide/start/running.md b/docs/guide/start/running.md index cb1cfe7..4053e0c 100644 --- a/docs/guide/start/running.md +++ b/docs/guide/start/running.md @@ -1,7 +1,7 @@ --- title: Running Brooklyn title_in_menu: Running Brooklyn -layout: guide-normal +layout: website-normal menu_parent: index.md --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/yaml/catalog-maintenance.md ---------------------------------------------------------------------- diff --git a/docs/guide/yaml/catalog-maintenance.md b/docs/guide/yaml/catalog-maintenance.md index d8eb877..4b05afc 100644 --- a/docs/guide/yaml/catalog-maintenance.md +++ b/docs/guide/yaml/catalog-maintenance.md @@ -1,6 +1,6 @@ --- title: Catalog Maintenance -layout: guide-normal +layout: website-normal toc: ../guide_toc.json categories: [use, guide, catalog-maintenance] --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/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 0c7dcd6..db3ec3c 100644 --- a/docs/guide/yaml/chef/about-chef.md +++ b/docs/guide/yaml/chef/about-chef.md @@ -1,7 +1,7 @@ --- title: About Chef title_in_menu: About Chef -layout: guide-normal +layout: website-normal --- ## What you need to know about Chef http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/yaml/chef/advanced-chef-integration.md ---------------------------------------------------------------------- diff --git a/docs/guide/yaml/chef/advanced-chef-integration.md b/docs/guide/yaml/chef/advanced-chef-integration.md index 9a7cc67..18a4ff9 100644 --- a/docs/guide/yaml/chef/advanced-chef-integration.md +++ b/docs/guide/yaml/chef/advanced-chef-integration.md @@ -1,7 +1,7 @@ --- title: Advanced Chef Integration title_in_menu: Advanced Chef Integration -layout: guide-normal +layout: website-normal --- ### Adding Sensors and Effectors http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/yaml/chef/creating-blueprints.md ---------------------------------------------------------------------- diff --git a/docs/guide/yaml/chef/creating-blueprints.md b/docs/guide/yaml/chef/creating-blueprints.md index b97f6d1..d584a4e 100644 --- a/docs/guide/yaml/chef/creating-blueprints.md +++ b/docs/guide/yaml/chef/creating-blueprints.md @@ -1,7 +1,7 @@ --- title: Creating Blueprints from Chef title_in_menu: Creating Blueprints from Chef -layout: guide-normal +layout: website-normal --- In a nutshell, a new Chef-based entity can be defined as a service by specifying http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/yaml/chef/writing-chef.md ---------------------------------------------------------------------- diff --git a/docs/guide/yaml/chef/writing-chef.md b/docs/guide/yaml/chef/writing-chef.md index 3fa9401..0593837 100644 --- a/docs/guide/yaml/chef/writing-chef.md +++ b/docs/guide/yaml/chef/writing-chef.md @@ -1,7 +1,7 @@ --- title: Writing Chef for Blueprints title_in_menu: Writing Chef for Blueprints -layout: guide-normal +layout: website-normal --- ## Making it Simpler http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/yaml/clusters-and-policies.md ---------------------------------------------------------------------- diff --git a/docs/guide/yaml/clusters-and-policies.md b/docs/guide/yaml/clusters-and-policies.md index e41115b..fc65179 100644 --- a/docs/guide/yaml/clusters-and-policies.md +++ b/docs/guide/yaml/clusters-and-policies.md @@ -1,6 +1,6 @@ --- title: Clusters and Policies -layout: guide-normal +layout: website-normal toc: ../guide_toc.json categories: [use, guide, defining-applications] --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/yaml/clusters.md ---------------------------------------------------------------------- diff --git a/docs/guide/yaml/clusters.md b/docs/guide/yaml/clusters.md index fc519a2..854254e 100644 --- a/docs/guide/yaml/clusters.md +++ b/docs/guide/yaml/clusters.md @@ -1,6 +1,6 @@ --- title: Clusters, Specs, and Composition -layout: guide-normal +layout: website-normal toc: ../guide_toc.json categories: [use, guide, defining-applications] --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/yaml/configuring-vms.md ---------------------------------------------------------------------- diff --git a/docs/guide/yaml/configuring-vms.md b/docs/guide/yaml/configuring-vms.md index 280fa19..709746c 100644 --- a/docs/guide/yaml/configuring-vms.md +++ b/docs/guide/yaml/configuring-vms.md @@ -1,6 +1,6 @@ --- title: Configuring VMs -layout: guide-normal +layout: website-normal toc: ../guide_toc.json categories: [use, guide, defining-applications] --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/yaml/creating-yaml.md ---------------------------------------------------------------------- diff --git a/docs/guide/yaml/creating-yaml.md b/docs/guide/yaml/creating-yaml.md index 012c67e..6141a18 100644 --- a/docs/guide/yaml/creating-yaml.md +++ b/docs/guide/yaml/creating-yaml.md @@ -1,6 +1,6 @@ --- title: The Basic Structure -layout: guide-normal +layout: website-normal toc: ../guide_toc.json categories: [use, guide, defining-applications] --- @@ -52,17 +52,24 @@ TODO building up children entities ### More Information +Topics to explore next on the topic of YAML blueprints are: + +{% include list-children.html %} + Plenty of examples of blueprints exist in the Brooklyn codebase, -so a good starting point is to [`git clone`]({{ site.path.guide }}/dev/code/index.html) it +so another 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. For more information on this: +by dropping to the JVM. For more information on Java: + * 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 + +<!-- +TODO * review some [examples]({{site.path.guide}}/use/examples/index.html) --> http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/yaml/custom-entities.md ---------------------------------------------------------------------- diff --git a/docs/guide/yaml/custom-entities.md b/docs/guide/yaml/custom-entities.md index 8e9638d..04f7763 100644 --- a/docs/guide/yaml/custom-entities.md +++ b/docs/guide/yaml/custom-entities.md @@ -1,6 +1,6 @@ --- title: Custom Entities -layout: guide-normal +layout: website-normal toc: ../guide_toc.json categories: [use, guide, defining-applications] --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/yaml/multiple-services.md ---------------------------------------------------------------------- diff --git a/docs/guide/yaml/multiple-services.md b/docs/guide/yaml/multiple-services.md index 17e1f04..a6816e6 100644 --- a/docs/guide/yaml/multiple-services.md +++ b/docs/guide/yaml/multiple-services.md @@ -1,6 +1,6 @@ --- title: Multiple Services and Dependency Injection -layout: guide-normal +layout: website-normal toc: ../guide_toc.json categories: [use, guide, defining-applications] --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/yaml/mutlitple-services.md ---------------------------------------------------------------------- diff --git a/docs/guide/yaml/mutlitple-services.md b/docs/guide/yaml/mutlitple-services.md index b5dfe34..24f7b1d 100644 --- a/docs/guide/yaml/mutlitple-services.md +++ b/docs/guide/yaml/mutlitple-services.md @@ -1,6 +1,6 @@ --- title: Multiple Services and Dependency Injection -layout: guide-normal +layout: website-normal toc: ../guide_toc.json categories: [use, guide, defining-applications] --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e424b743/docs/guide/yaml/setting-locations.md ---------------------------------------------------------------------- diff --git a/docs/guide/yaml/setting-locations.md b/docs/guide/yaml/setting-locations.md index d279460..4924557 100644 --- a/docs/guide/yaml/setting-locations.md +++ b/docs/guide/yaml/setting-locations.md @@ -1,6 +1,6 @@ --- title: Setting Locations -layout: guide-normal +layout: website-normal toc: ../guide_toc.json categories: [use, guide, defining-applications] ---
