You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by ri...@apache.org on 2017/05/18 12:37:52 UTC
svn commit: r1795513 [30/45] - in /brooklyn/site: ./ community/
community/security/ contributing/ developers/ developers/code/
developers/committers/ developers/committers/release-process/
documentation/ download/ learnmore/ learnmore/catalog/ learnmor...
Modified: brooklyn/site/documentation/faq.html
URL: http://svn.apache.org/viewvc/brooklyn/site/documentation/faq.html?rev=1795513&r1=1795512&r2=1795513&view=diff
==============================================================================
--- brooklyn/site/documentation/faq.html (original)
+++ brooklyn/site/documentation/faq.html Thu May 18 12:37:51 2017
@@ -1,389 +1,355 @@
<!--
-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.
--->
-
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
-
+ ~ 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.
+ -->
+<!DOCTYPE html>
+<html lang="en">
<head>
+ <title>FAQ - Apache Brooklyn</title>
-
-<title>FAQ - Apache Brooklyn</title>
-
-<meta http-equiv="content-type" content="text/html; charset=utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1">
-
-<link href="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css" rel="stylesheet">
-<link href="/style/deps/octicons/octicons.css" rel="stylesheet">
-<link href="/style/deps/bootstrap-theme.css" rel="stylesheet">
-
-<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
-<script src="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
-<script type="text/javascript" src="/style/deps/jquery.cookie.js"></script>
-
-
-
-<link rel="stylesheet" href="/style/css/code.css" type="text/css" media="screen" />
-<link href="/style/css/website.css" rel="stylesheet">
-
+<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+<meta name="viewport" content="width=device-width, initial-scale=1" />
+<link href="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css" rel="stylesheet" />
+<link href="/style/deps/octicons/octicons.css" rel="stylesheet" />
+<link href="/style/deps/bootstrap-theme.css" rel="stylesheet" />
+<link href="/style/deps/font-awesome-4.2.0/css/font-awesome.min.css" rel="stylesheet" />
+<link href="/style/deps/tooltip.css" rel="stylesheet" />
+<link href="/style/css/code.css" rel="stylesheet" />
+<link href="/style/css/website.css" rel="stylesheet" />
+<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
</head>
-
-<body>
-
-<nav class="navbar navbar-default navbar-fixed-top" id="header" role="navigation">
- <div class="container-and-sidebars">
-
- <div class="container-sidebar-left feather">
- <a href="http://www.apache.org/">
- <img src="/style/img/feather.png" alt="[Apache]" width="80" class="flip navbar-feather">
- </a>
+<body class="page">
+<nav class="navbar navbar-default navbar-fixed-top" role="navigation">
+ <div class="container">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#main-menu" aria-expanded="false">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a href="/" class="navbar-brand">
+ <img src="/style/img/apache-brooklyn-logo-244px-wide.png" alt="Apache Brooklyn" />
+ </a>
</div>
-
- <div class="container container-between-sidebars top-menu">
- <div class="container-fluid">
- <!-- Brand and toggle get grouped for better mobile display -->
- <div class="navbar-header">
- <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
- <span class="sr-only">Toggle navigation</span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
- <a class="navbar-brand" href="/"><img src="/style/img/apache-brooklyn-logo-244px-wide.png" alt="brooklyn"></a>
- </div>
-
- <!-- Collect the nav links, forms, and other content for toggling -->
- <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
- <ul class="nav navbar-nav navbar-right">
-
-
- <li class="dropdown">
- <a href="/learnmore/index.html">learn more</a>
- <ul class="dropdown-menu" role="menu">
- <li>
- <a href="/learnmore/index.html">Learn More</a>
- </li>
- <li class="divider"></li>
-
- <li>
-
- <a href="/learnmore/blueprint-tour.html">Blueprint Tour
- </a>
-
- </li>
-
- <li>
-
- <a href="/learnmore/features/index.html">Features
- </a>
-
- </li>
-
- <li>
-
- <a href="/learnmore/theory.html">Theory
- </a>
-
- </li>
-
- <li>
-
- <a href="/learnmore/catalog/index.html">Browse Catalog
- </a>
-
- </li>
-
- </ul>
- </li>
-
-
-
- <li class="">
- <a href="/download/index.html">download</a>
- </li>
-
-
-
- <li class="dropdown">
- <a href="/v/latest/start/index.html">get started</a>
- <ul class="dropdown-menu" role="menu">
- <li>
- <a href="/v/latest/start/index.html">Get Started</a>
- </li>
- <li class="divider"></li>
-
- <li>
-
- <a href="/v/latest/start/running.html">Running Apache Brooklyn
- </a>
-
- </li>
-
- <li>
-
- <a href="/v/latest/start/blueprints.html">Deploying Blueprints
- </a>
-
- </li>
-
- <li>
-
- <a href="/v/latest/start/managing.html">Monitoring and Managing Applications
- </a>
-
- </li>
-
- <li>
-
- <a href="/v/latest/start/policies.html">Policies
- </a>
-
- </li>
-
- <li>
-
- <a href="/v/latest/start/concept-quickstart.html">Brooklyn Concepts Quickstart
- </a>
-
- </li>
-
- </ul>
- </li>
-
-
-
- <li class="dropdown">
- <a href="/documentation/index.html">documentation</a>
- <ul class="dropdown-menu" role="menu">
- <li>
- <a href="/documentation/index.html">Documentation</a>
- </li>
- <li class="divider"></li>
-
- <li>
-
- <a href="/v/latest/index.html">User Guide
- </a>
-
- <div class="dropdown_section_header"><hr></div>
-
- </li>
-
- <li>
-
- <a href="/v/latest/yaml/creating-yaml.html">YAML Blueprints
- </a>
-
- </li>
-
- <li>
-
- <a href="/v/latest/java/index.html">Java Blueprints
- </a>
-
- </li>
-
- <li>
-
- <a href="/v/latest/ops/index.html">Operations
- </a>
-
- <div class="dropdown_section_header"><hr></div>
-
- </li>
-
- <li>
-
- <a href="/v/latest/dev/index.html">Developer Guide
- </a>
-
- </li>
-
- <li>
-
- <div class="dropdown_new_section"><hr></div>
-
- <a href="/meta/versions.html">Versions
- </a>
-
- </li>
-
- <li>
-
- <a href="/documentation/other-docs.html">Other Resources
- </a>
-
- </li>
-
- </ul>
- </li>
-
-
-
- <li class="dropdown">
- <a href="/community/index.html">community</a>
- <ul class="dropdown-menu" role="menu">
- <li>
- <a href="/community/index.html">Community</a>
- </li>
- <li class="divider"></li>
-
- <li>
-
- <a href="/community/mailing-lists.html">Mailing Lists
- </a>
-
- </li>
-
- <li>
-
- <a href="/community/irc.html">IRC
- </a>
-
- </li>
-
- <li>
-
- <a href="/community/security/index.html">Security Advisories
- </a>
-
- </li>
-
- <li>
-
- <a href="https://issues.apache.org/jira/browse/BROOKLYN">Bug Tracker (JIRA)
- <span class="octicon octicon-link-external"></span></a>
-
- </li>
-
- <li>
-
- <a href="/community/how-to-contribute-docs.html">Contributing Documentation
- </a>
-
- </li>
-
- </ul>
- </li>
-
-
-
- <li class="dropdown">
- <a href="/developers/index.html">developers</a>
- <ul class="dropdown-menu" role="menu">
- <li>
- <a href="/developers/index.html">Developers</a>
- </li>
- <li class="divider"></li>
-
- <li>
-
- <a href="/developers/code/index.html">Get the Code
- </a>
-
- </li>
-
- <li>
-
- <a href="/developers/how-to-contribute.html">How to Contribute
- </a>
-
- </li>
-
- <li>
-
- <a href="/v/latest/dev/index.html">Developer Guide
- </a>
-
- </li>
-
- <li>
-
- <a href="/developers/committers/index.html">Committer Guide
- </a>
-
- </li>
-
- <li>
-
- <a href="/developers/code-standards.html">Code Standards
- </a>
-
- </li>
-
- <li>
-
- <a href="/developers/links.html">Handy Places
- </a>
-
- </li>
-
- <li>
-
- <a href="http://github.com/apache/brooklyn">GitHub
- <span class="octicon octicon-link-external"></span></a>
-
- </li>
-
- <li>
-
- <a href="https://issues.apache.org/jira/browse/BROOKLYN">Bug Tracker (JIRA)
- <span class="octicon octicon-link-external"></span></a>
-
- </li>
-
- </ul>
- </li>
-
-
- </ul>
- </div><!-- /.navbar-collapse -->
- </div><!-- /.container-fluid -->
- </div><!-- /.container -->
-
- <div class="container-sidebar-right">
- <div class="navbar-sidebar-right-icons">
- <a href="https://github.com/apache/brooklyn" class="navbar-icon navbar-icon-shift icon-github"
- data-toggle="tooltip" data-placement="bottom" title="GitHub: apache/brooklyn"/>
- <a href="https://twitter.com/#!/search?q=brooklyncentral" class="navbar-icon navbar-icon-shift icon-twitter"
- data-toggle="tooltip" data-placement="bottom" title="Twitter: @brooklyncentral"/>
- <a href="http://webchat.freenode.net/?channels=brooklyncentral" class="navbar-icon icon-irc"
- data-toggle="tooltip" data-placement="bottom" title="IRC: freenode #brooklyncentral"/>
- <!-- extra a element seems needed as landing page seems to copy the last element here (!?)
- -->
- <a href="/" style="width: 0px; height: 0px;"></a>
- </div>
- </div>
-
- </div>
+ <div class="collapse navbar-collapse" id="main-menu">
+ <ul class="nav navbar-nav navbar-right">
+
+ <li class="dropdown">
+
+ <a href="/learnmore/index.html" data-toggle="dropdown">learn more <span class="caret"></span></a>
+
+ <ul class="dropdown-menu" role="menu">
+ <li>
+ <a href="/learnmore/index.html">Learn More</a>
+ </li>
+ <li class="divider"></li>
+
+
+ <li >
+ <a href="/learnmore/blueprint-tour.html">Blueprint Tour
+ </a>
+ </li>
+
+
+
+ <li >
+ <a href="/learnmore/features/index.html">Features
+ </a>
+ </li>
+
+
+
+ <li >
+ <a href="/learnmore/theory.html">Theory
+ </a>
+ </li>
+
+
+
+ <li >
+ <a href="/learnmore/catalog/index.html">Browse Catalog
+ </a>
+ </li>
+
+
+ </ul>
+
+
+ </li>
+
+ <li class="dropdown">
+
+ <a href="/v/latest/start/index.html" data-toggle="dropdown">get started <span class="caret"></span></a>
+
+ <ul class="dropdown-menu" role="menu">
+ <li>
+ <a href="/v/latest/start/index.html">Get Started</a>
+ </li>
+ <li class="divider"></li>
+
+
+ <li >
+ <a href="/v/latest/start/running.html">Running Apache Brooklyn
+ </a>
+ </li>
+
+
+
+ <li >
+ <a href="/v/latest/start/blueprints.html">Deploying Blueprints
+ </a>
+ </li>
+
+
+
+ <li >
+ <a href="/v/latest/start/managing.html">Monitoring and Managing Applications
+ </a>
+ </li>
+
+
+
+ <li >
+ <a href="/v/latest/start/policies.html">Policies
+ </a>
+ </li>
+
+
+
+ <li >
+ <a href="/v/latest/start/concept-quickstart.html">Brooklyn Concepts Quickstart
+ </a>
+ </li>
+
+
+ </ul>
+
+
+ </li>
+
+ <li class="dropdown">
+
+ <a href="/documentation/index.html" data-toggle="dropdown">documentation <span class="caret"></span></a>
+
+ <ul class="dropdown-menu" role="menu">
+ <li>
+ <a href="/documentation/index.html">Documentation</a>
+ </li>
+ <li class="divider"></li>
+
+
+ <li class="section">
+ <a href="/v/latest/index.html">User Guide
+ </a>
+ </li>
+ <li class="divider"></li>
+
+
+ <li >
+ <a href="/v/latest/blueprints/creating-yaml.html">Writing Blueprints
+ </a>
+ </li>
+
+
+
+ <li >
+ <a href="/v/latest/locations/index.html">Deploying Blueprints
+ </a>
+ </li>
+
+
+
+ <li class="section">
+ <a href="/v/latest/ops/index.html">Reference Guide
+ </a>
+ </li>
+ <li class="divider"></li>
+
+
+ <li >
+ <a href="/v/latest/dev/index.html">Developer Guide
+ </a>
+ </li>
+
+
+ <li class="divider"></li>
+ <li >
+ <a href="/meta/versions.html">Versions
+ </a>
+ </li>
+
+
+
+ <li >
+ <a href="/documentation/other-docs.html">Other Resources
+ </a>
+ </li>
+
+
+ </ul>
+
+
+ </li>
+
+ <li class="dropdown">
+
+ <a href="/community/index.html" data-toggle="dropdown">community <span class="caret"></span></a>
+
+ <ul class="dropdown-menu" role="menu">
+ <li>
+ <a href="/community/index.html">Community</a>
+ </li>
+ <li class="divider"></li>
+
+
+ <li >
+ <a href="/community/mailing-lists.html">Mailing Lists
+ </a>
+ </li>
+
+
+
+ <li >
+ <a href="/community/irc.html">IRC
+ </a>
+ </li>
+
+
+
+ <li >
+ <a href="/community/security/index.html">Security Advisories
+ </a>
+ </li>
+
+
+
+ <li >
+ <a href="https://issues.apache.org/jira/browse/BROOKLYN">Bug Tracker (JIRA)
+ <span class="octicon octicon-link-external"></span></a>
+ </li>
+
+
+
+ <li >
+ <a href="/community/how-to-contribute-docs.html">Contributing Documentation
+ </a>
+ </li>
+
+
+ </ul>
+
+
+ </li>
+
+ <li class="dropdown">
+
+ <a href="/developers/index.html" data-toggle="dropdown">developers <span class="caret"></span></a>
+
+ <ul class="dropdown-menu" role="menu">
+ <li>
+ <a href="/developers/index.html">Developers</a>
+ </li>
+ <li class="divider"></li>
+
+
+ <li >
+ <a href="/developers/code/index.html">Get the Code
+ </a>
+ </li>
+
+
+
+ <li >
+ <a href="/developers/how-to-contribute.html">How to Contribute
+ </a>
+ </li>
+
+
+
+ <li >
+ <a href="/v/latest/dev/index.html">Developer Guide
+ </a>
+ </li>
+
+
+
+ <li >
+ <a href="/developers/committers/index.html">Committer Guide
+ </a>
+ </li>
+
+
+
+ <li >
+ <a href="/developers/code-standards.html">Code Standards
+ </a>
+ </li>
+
+
+
+ <li >
+ <a href="/developers/links.html">Handy Places
+ </a>
+ </li>
+
+
+
+ <li >
+ <a href="http://github.com/apache/brooklyn">GitHub
+ <span class="octicon octicon-link-external"></span></a>
+ </li>
+
+
+
+ <li >
+ <a href="https://issues.apache.org/jira/browse/BROOKLYN">Bug Tracker (JIRA)
+ <span class="octicon octicon-link-external"></span></a>
+ </li>
+
+
+ </ul>
+
+
+ </li>
+
+ <li class="dropdown">
+
+ <a href="/download/index.html" class="btn btn-default navbar-btn">download</a>
+
+ </li>
+
+ </ul>
+ </div>
+ </div>
</nav>
-<div class="container" id="main_container">
- <div class="row">
- <div class="col-md-9" id="content_container">
- <div id="page_notes"></div>
- <h1>FAQ</h1>
- <h2 id="whats-the-difference-between-brooklyn-and">Whatâs the difference between Brooklyn andâ¦</h2>
+<main>
+ <div class="container">
+ <div class="row">
+ <div class="col-md-9 content">
+ <div id="page_notes"></div>
+ <h1>FAQ</h1>
+ <h2 id="whats-the-difference-between-brooklyn-and">Whatâs the difference between Brooklyn andâ¦</h2>
<h4 id="chef-and-puppet-and-other-server-config-management-tools">Chef and Puppet and other server config management tools?</h4>
@@ -399,10 +365,10 @@ under the License.
<p>Click the âEdit this Pageâ link in the bottom right.</p>
- </div>
+ </div>
- <div class="col-md-3">
- <div class="list-group side-menu" id="side-menu">
+ <aside class="col-md-3">
+ <div class="list-group side-menu" id="side-menu">
@@ -420,365 +386,225 @@ under the License.
<script language="JavaScript" type="application/javascript">
+(function($){
+
+ sidemenu_x_sizer=function(){ $('#side-menu').width($('#side-menu').parent().find('#width_reference').outerWidth()); };
+ $(sidemenu_x_sizer);
+ $(window).resize(sidemenu_x_sizer);
+
+
+ sidemenu_y_nonfloater=function(){
+ if ($('#side-menu').outerHeight(true) + $('#header').outerHeight(true) + $('#footer').outerHeight(true) > window.innerHeight ||
+ $('#side-menu').width() >= $('#content_container').width()/2) {
+ $('#side-menu').css('position', 'inherit');
+ } else {
+ // restore if screen has grown
+ $('#side-menu').css('position', 'fixed');
+ }
+ };
+ $(sidemenu_y_nonfloater);
+ $(window).resize(sidemenu_y_nonfloater);
+
+
+
+ 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_completed = false;
+
+ var highlight_section = function() {
+ // 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);
+
+ var last_item = null, active_item = $("#side-menu a.section#active");
+
+ var found_top = false;
+ var displayable_items = scrollItems.map(function(itemI){
+ item = $(scrollItems[itemI]);
+ if (item && item.length) {
+ if (highlight_section_last_top == -1 || !highlight_section_completed) {
+ // just opening page - take item matching hash, or otherwise the first item visible
+ if (item.selector === window.location.hash || (item.offset().top > highlight_section_new_top - 20 && !found_top)) {
+ found_top = true;
+ if (item.selector === window.location.hash && item.offset().top < highlight_section_new_top + 60) {
+ // because of our top header, we need to scroll 64px down from any link
+ $('html, body').animate({scrollTop: item.offset().top - 64}, 0);
+ }
+ return item;
+ }
+ } else 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 <= displayable_itemsrent_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;
-
-sidemenu_x_sizer=function(){ $('#side-menu').width($('#side-menu').parent().find('#width_reference').outerWidth()); };
-$(sidemenu_x_sizer);
-$(window).resize(sidemenu_x_sizer);
-
-
-sidemenu_y_nonfloater=function(){
- if ($('#side-menu').outerHeight(true) + $('#header').outerHeight(true) + $('#footer').outerHeight(true) > window.innerHeight ||
- $('#side-menu').width() >= $('#content_container').width()/2) {
- $('#side-menu').css('position', 'inherit');
- } else {
- // restore if screen has grown
- $('#side-menu').css('position', 'fixed');
- }
-};
-$(sidemenu_y_nonfloater);
-$(window).resize(sidemenu_y_nonfloater);
-
-
-
-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_completed = false;
-
-var highlight_section = function() {
- // 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);
-
- var last_item = null, active_item = $("#side-menu a.section#active");
-
- var found_top = false;
- var displayable_items = scrollItems.map(function(itemI){
- item = $(scrollItems[itemI]);
- if (item && item.length) {
- if (highlight_section_last_top == -1 || !highlight_section_completed) {
- // just opening page - take item matching hash, or otherwise the first item visible
- if (item.selector === window.location.hash || (item.offset().top > highlight_section_new_top - 20 && !found_top)) {
- found_top = true;
- if (item.selector === window.location.hash && item.offset().top < highlight_section_new_top + 60) {
- // because of our top header, we need to scroll 64px down from any link
- $('html, body').animate({scrollTop: item.offset().top - 64}, 0);
}
- return item;
+ last_item = item;
}
- } else 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;
+ });
+ if (!highlight_section_completed && document.readyState === "complete") {
+ highlight_section_completed = true;
+ }
+ if (!displayable_items.length) {
+ $("#side-menu a.section").removeClass("active");
} 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 <= displayable_itemsrent_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;
-
+ displayable_items = displayable_items[displayable_items.length-1];
+ var id = displayable_items && displayable_items.length ? displayable_items[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");
+ }
}
- last_item = item;
- }
- });
- if (!highlight_section_completed && document.readyState === "complete") {
- highlight_section_completed = true;
- }
- if (!displayable_items.length) {
- $("#side-menu a.section").removeClass("active");
- } else {
- displayable_items = displayable_items[displayable_items.length-1];
- var id = displayable_items && displayable_items.length ? displayable_items[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;
-};
-var highlight_new_section = function() {
- highlight_section_completed = false;
- highlight_section_last_top = -1;
- highlight_section();
-}
-
-$(window).scroll(highlight_section);
-$(highlight_new_section);
-
-// detect link change - courtesy http://www.bennadel.com/blog/1520-binding-events-to-non-dom-objects-with-jquery.htm
- (
- function( $ ){
- // Default to the current location.
- var strLocation = window.location.href;
- var strHash = window.location.hash;
- var strPrevLocation = "";
- var strPrevHash = "";
-
- // This is how often we will be checkint for
- // changes on the location.
- var intIntervalTime = 100;
-
- // This method removes the pound from the hash.
- var fnCleanHash = function( strHash ){
- return(
- strHash.substring( 1, strHash.length )
- );
- }
-
- // This will be the method that we use to check
- // changes in the window location.
- var fnCheckLocation = function(){
- // Check to see if the location has changed.
- if (strLocation != window.location.href){
-
- // Store the new and previous locations.
- strPrevLocation = strLocation;
- strPrevHash = strHash;
- strLocation = window.location.href;
- strHash = window.location.hash;
-
- // The location has changed. Trigger a
- // change event on the location object,
- // passing in the current and previous
- // location values.
- $( window.location ).trigger(
- "change",
- {
- currentHref: strLocation,
- currentHash: fnCleanHash( strHash ),
- previousHref: strPrevLocation,
- previousHash: fnCleanHash( strPrevHash )
- }
- );
+ highlight_section_last_top = highlight_section_new_top;
+ };
+ var highlight_new_section = function() {
+ highlight_section_completed = false;
+ highlight_section_last_top = -1;
+ highlight_section();
+ }
+
+ $(window).scroll(highlight_section);
+ $(highlight_new_section);
+
+ // detect link change - courtesy http://www.bennadel.com/blog/1520-binding-events-to-non-dom-objects-with-jquery.htm
+
+ // Default to the current location.
+ var strLocation = window.location.href;
+ var strHash = window.location.hash;
+ var strPrevLocation = "";
+ var strPrevHash = "";
+
+ // This is how often we will be checkint for
+ // changes on the location.
+ var intIntervalTime = 100;
+
+ // This method removes the pound from the hash.
+ var fnCleanHash = function( strHash ){
+ return(
+ strHash.substring( 1, strHash.length )
+ );
+ }
+
+ // This will be the method that we use to check
+ // changes in the window location.
+ var fnCheckLocation = function(){
+ // Check to see if the location has changed.
+ if (strLocation != window.location.href){
+
+ // Store the new and previous locations.
+ strPrevLocation = strLocation;
+ strPrevHash = strHash;
+ strLocation = window.location.href;
+ strHash = window.location.hash;
+
+ // The location has changed. Trigger a
+ // change event on the location object,
+ // passing in the current and previous
+ // location values.
+ $( window.location ).trigger(
+ "change",
+ {
+ currentHref: strLocation,
+ currentHash: fnCleanHash( strHash ),
+ previousHref: strPrevLocation,
+ previousHash: fnCleanHash( strPrevHash )
}
- }
+ );
- // Set an interval to check the location changes.
- setInterval( fnCheckLocation, intIntervalTime );
}
- )( jQuery );
-// and trigger highlight section on link change
-$(window.location).bind("change", highlight_new_section);
+ }
+
+ // Set an interval to check the location changes.
+ setInterval( fnCheckLocation, intIntervalTime );
+
+ // and trigger highlight section on link change
+ $(window.location).bind("change", highlight_new_section);
+})(jQuery);
</script>
+ </aside>
</div>
</div>
-</div>
+</main>
-<div id="footer">
- <div class="container">
- <div class="row">
- <div class="col-md-10 text-muted">
- Apache Brooklyn is distributed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License v2.0</a>.
- </div>
- <div class="col-md-2">
+<footer class="container">
+ <div class="row">
+ <div class="col-md-9">
+ <p>Apache Brooklyn is distributed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License v2.0</a>.</p>
+ </div>
+ <div class="col-md-3 text-right">
+ <p>
<a class="btn btn-sm btn-default" href="https://github.com/apache/brooklyn-docs/edit/master/website/documentation/faq.md">Edit This Page</a>
<a href="https://brooklyn.apache.org/community/how-to-contribute-docs.html"
- data-toggle="tooltip" data-placement="top" title="How to Edit Documentation" data-delay="400"/>
- <span class="octicon octicon-question octicon-footer"></span>
+ data-toggle="tooltip" data-placement="top" title="" data-delay="400" data-original-title="How to Edit Documentation">
+ <span class="octicon octicon-question octicon-footer"></span>
</a>
- </div>
+ </p>
</div>
</div>
-</div>
-
-
-
-
-<script language="JavaScript" type="application/javascript">
-
- fix_padding_function = function () {
- $('body').css('padding-top', parseInt($('#header').css("height"))+10);
- $('body').css('padding-bottom', parseInt($('#footer').css("height"))+10);
- };
- $(window).resize(fix_padding_function);
- $(window).load(fix_padding_function);
-
- $(function () {
- $('[data-toggle="tooltip"]').tooltip({ delay: { show: 600, hide: 100 }})
- });
-
-/* generate anchors for headers, a la github and http://blog.parkermoore.de/2014/08/01/header-anchor-links-in-vanilla-javascript-for-github-pages-and-jekyll/ */
-var anchorForId = function (id, text) {
- var anchor = document.createElement("a");
- anchor.className = "header-link";
- anchor.href = "#" + id;
- anchor.innerHTML = "<i class=\"fa fa-link\"></i>";
- return anchor;
-};
-
-var linkifyAnchors = function (level, containingElement) {
- var headers = contentBlock.find("h" + level);
- for (var h = 0; h < headers.length; h++) {
- var header = headers[h];
- if (typeof header.id !== "undefined" && header.id !== "") {
- header.appendChild(anchorForId(header.id, $(header).text()));
- }
- }
-};
-
-$(function () {
- contentBlock = $("#content_container");
- if (!contentBlock) return;
- for (var level = 1; level <= 6; level++) {
- linkifyAnchors(level, contentBlock);
- }
-});
-
-<!-- Copying and clipboard support -->
-
-// first make the $% line starts not selectable
-
-$(function() {
- $('div.highlight').attr('oncopy', 'handleHideCopy(this)');
- $('div.highlight').each(function(index,target) {
- if ($(target).find('code.bash')) {
- // Mark bash prompts from the start of each line (i.e. '$' or '%' characters
- // at the very start, or immediately following any newline) as not-selectable.
- // Handle continuation lines where a leading '$' or '%' is *not* a prompt character.
- // (If example wants to exclude output, it can manually use class="nocopy".)
- target.innerHTML = target.innerHTML.replace(/(^\s*|[^\\]\n)(<.*>)?([$%]|>) /g, '$1$2<span class="nocopy bash_prompt">$3 </span>');
- }
- });
-});
-
-// normal cmd-C (non-icon) copying
-
-function handleHideCopy(el) {
-// var origHtml = $(el).clone();
- console.log("handling copy", el);
- $(el).addClass('copying');
- $(el).find('.nocopy').hide();
- $(el).find('.clipboard_button').addClass('manual-clipboard-is-active');
- setTimeout(function(){
- $(el).removeClass('copying');
- $(el).find('.clipboard_button').removeClass('manual-clipboard-is-active');
- $(el).find('.nocopy').show();
-// $(el).html(origHtml);
- }, 600);
-}
-
-// and icon (flash) copying
+</footer>
-</script>
-
-<script src="/style/js/zeroclipboard/ZeroClipboard.min.js"></script>
-
-<script language="JavaScript" type="application/javascript">
-
-ZeroClipboard.config({ moviePath: '/style/js/zeroclipboard/ZeroClipboard.swf' });
-
-$(function() {
- $('div.highlight').prepend(
- $('<div class="clipboard_container" title="Copy to Clipboard">'+
- '<div class="fa clipboard_button">'+
- '<div class="on-active"><div>Copied to Clipboard</div></div>'+
- '</div></div>'));
- $('div.clipboard_container').each(function(index) {
- var clipboard = new ZeroClipboard();
- clipboard.clip( $(this).find(":first")[0], $(this)[0] );
- var target0 = $(this).next();
- var target = target0.clone();
- target.find('.nocopy').remove();
- var txt = target.text();
- clipboard.on( 'dataRequested', function (client, args) {
- handleHideCopy( target0.closest('div.highlight') ); //not necessary but nicer feedback
- client.setText( txt );
- });
- });
-});
-
-
-<!-- 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();
- });
-
-
- <!-- 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);
- })();
-
-
-<!-- page warning (for archive pages) -->
+</body>
+<!--
+ ~ 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.
+ -->
- 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;
- };
+<script type="text/javascript" src="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
+<script type="text/javascript" src="/style/deps/jquery.cookie.js"></script>
+<script type="text/javascript" src="/style/js/zeroclipboard/ZeroClipboard.min.js"></script>
+<script type="text/javascript" src="/style/deps/tooltip.js"></script>
+<script type="text/javascript">
+ ZeroClipboard.config({ moviePath: '/style/js/zeroclipboard/ZeroClipboard.swf' });
</script>
-
-</body>
-
+<script src="/style/js/public.js"></script>
</html>