You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by he...@apache.org on 2015/01/20 00:00:25 UTC
[05/13] incubator-brooklyn git commit: reinstate several old pieces
of functionality
reinstate several old pieces of functionality
clipboard, warning for archived guides, search (only on sitemap), analytics (untested),
old code standards, and cleaning out some of the _extras folder; and recover deploying-yaml to go into the ops guide
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/783e6382
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/783e6382
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/783e6382
Branch: refs/heads/master
Commit: 783e6382331e82f1e0c15a10f73129163a44e26c
Parents: 24f0799
Author: Alex Heneveld <al...@cloudsoftcorp.com>
Authored: Wed Jan 14 14:23:44 2015 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
Committed: Thu Jan 15 16:33:00 2015 +0000
----------------------------------------------------------------------
docs/_extra/brooklyn-gpg-public-key.asc | 21 ++++
docs/_extra/deploying-yaml.md | 37 +++++++
docs/_extra/meta/brooklyn-gpg-public-key.asc | 21 ----
docs/_extra/meta/contact.include.md | 9 --
docs/_extra/meta/contact.md | 7 --
docs/_extra/meta/irc.md | 31 ------
docs/_extra/meta/toc.json | 8 --
docs/_extra/meta/versions.md | 110 --------------------
docs/_extra/standards.md | 15 ---
docs/_includes/base-head.html | 1 +
docs/_layouts/base.html | 117 ++++++++++++++++++++++
docs/_layouts/website-normal.html | 1 +
docs/guide/start/running.md | 8 +-
docs/style/css/base.scss | 116 ++++++++++++++++++++-
docs/website/developers/code-standards.md | 14 +++
docs/website/developers/index.md | 1 +
docs/website/meta/sitemap.md | 12 ++-
17 files changed, 321 insertions(+), 208 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/783e6382/docs/_extra/brooklyn-gpg-public-key.asc
----------------------------------------------------------------------
diff --git a/docs/_extra/brooklyn-gpg-public-key.asc b/docs/_extra/brooklyn-gpg-public-key.asc
new file mode 100644
index 0000000..3b515a4
--- /dev/null
+++ b/docs/_extra/brooklyn-gpg-public-key.asc
@@ -0,0 +1,21 @@
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+Version: GnuPG/MacGPG2 v2.0.18 (Darwin)
+Comment: GPGTools - http://gpgtools.org
+
+mQENBFDsSLEBCAC2JxQHeXpL3oGN2IickcG9C49gkxIsws4hpasQModVipezrQi0
+9pLq4lkB01GgC2sfPH+XXE8rCpA9EL0e4wVA7JICz5AsLZAAJH91tKksL20tLMeU
+Yrbufaq1ga7ifk3JWhF4iwvkDMBKyCjrF173nI+2TwX2XfNTQpzoQGOL1bNvS4NZ
+AD9JeXGW2D996zHdSK+x3wVdY3cDECvVMuw61+5ytZrGNnyvaaWTl3lJUyydPXHQ
+5TXVtbQH5WgYCLPr4E95axJ0BoY8H+fEaG1Uax1a+xLumVWhiWNp7rMvmgcZXuJO
+fx+wXAIbRNlAHoJcdZ4NCReRxDIBQ+2HsU1zABEBAAG0bUJyb29rbHluIFByb2pl
+Y3QgKGJyb29rbHluLmlvKSAoS2V5IHVzZWQgdG8gYXV0aGVudGljYXRlIEJyb29r
+bHluIGFydGlmYWN0cykgPGJyb29rbHluLWRldkBncm91cHMuZ29vZ2xlLmNvbT6J
+AT8EEwECACkFAlDsSLECGy8FCQeGH4AHCwkIBwMCAQYVCAIJCgsEFgIDAQIeAQIX
+gAAKCRANhinnSRLCsOdIB/4tUVShup2NHXJ9acCah8TuEN4GmN9dBiD9YsGW66SR
+/ptY0Gn9XExl2wbmQW+7TQg3QUGv8uffwYLtnMwnmCp/WwgE+uSnRmcENxa9GuTu
+PLlURKKGK0C9ljTAHwXtPcIYxPNN3BT4VB56ME1DTBRCgEvudaNSANs8/kT88kE2
+eMC7x0Uo3/P38Ob8XSOfR8c6G6nSz6jILcRBXZTPNNK4svyqF5XHIru65d3/0+mr
+bpfcDLcUQYms0MpPmO1RCHLZWwJLsPUIxNwGGnKJc8/RNEvQinK+Ap0cf+PGUQSX
+PhB6Z81ROFIVToEVZslgSiL+u4Tc7zXDfDQDY4HeLY2t
+=w/CG
+-----END PGP PUBLIC KEY BLOCK-----
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/783e6382/docs/_extra/deploying-yaml.md
----------------------------------------------------------------------
diff --git a/docs/_extra/deploying-yaml.md b/docs/_extra/deploying-yaml.md
new file mode 100644
index 0000000..265f496
--- /dev/null
+++ b/docs/_extra/deploying-yaml.md
@@ -0,0 +1,37 @@
+---
+title: Deploying YAML Blueprints
+layout: page
+toc: ../guide_toc.json
+categories: [use, guide, defining-applications]
+---
+
+Once you've [written a YAML blueprint](creating-yaml.md), there are several ways to deploy it.
+These insructions assume you have [installed]({{ site.url }}/use/guide/quickstart/) Brooklyn.
+You can then:
+
+- Supply the YAML blueprint file on the CLI when launching the server:
+
+{% highlight bash %}
+$ brooklyn launch --app ./blueprint.yaml
+{% endhighlight %}
+
+
+Or, assuming you've launched a server already
+(usually on [http://127.0.0.1/](http://127.0.0.1/) unless you've
+configured security in [`brooklyn.properties`](/use/guide/quickstart/brooklyn.properties)),
+you can:
+
+- Curl it to the Brooklyn REST API:
+
+{% highlight bash %}
+$ curl -T ./blueprint.yaml -X POST http://localhost:8081/v1/applications
+{% endhighlight %}
+
+
+- In the web-console, select the "YAML" tab in the "Add Application" wizard:
+
+[](web-console-yaml.png)
+
+
+- The web-console also has an interactive "REST API" page,
+ where you can paste the YAML for uploading into the `POST` to `/v1/applications`.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/783e6382/docs/_extra/meta/brooklyn-gpg-public-key.asc
----------------------------------------------------------------------
diff --git a/docs/_extra/meta/brooklyn-gpg-public-key.asc b/docs/_extra/meta/brooklyn-gpg-public-key.asc
deleted file mode 100644
index 3b515a4..0000000
--- a/docs/_extra/meta/brooklyn-gpg-public-key.asc
+++ /dev/null
@@ -1,21 +0,0 @@
------BEGIN PGP PUBLIC KEY BLOCK-----
-Version: GnuPG/MacGPG2 v2.0.18 (Darwin)
-Comment: GPGTools - http://gpgtools.org
-
-mQENBFDsSLEBCAC2JxQHeXpL3oGN2IickcG9C49gkxIsws4hpasQModVipezrQi0
-9pLq4lkB01GgC2sfPH+XXE8rCpA9EL0e4wVA7JICz5AsLZAAJH91tKksL20tLMeU
-Yrbufaq1ga7ifk3JWhF4iwvkDMBKyCjrF173nI+2TwX2XfNTQpzoQGOL1bNvS4NZ
-AD9JeXGW2D996zHdSK+x3wVdY3cDECvVMuw61+5ytZrGNnyvaaWTl3lJUyydPXHQ
-5TXVtbQH5WgYCLPr4E95axJ0BoY8H+fEaG1Uax1a+xLumVWhiWNp7rMvmgcZXuJO
-fx+wXAIbRNlAHoJcdZ4NCReRxDIBQ+2HsU1zABEBAAG0bUJyb29rbHluIFByb2pl
-Y3QgKGJyb29rbHluLmlvKSAoS2V5IHVzZWQgdG8gYXV0aGVudGljYXRlIEJyb29r
-bHluIGFydGlmYWN0cykgPGJyb29rbHluLWRldkBncm91cHMuZ29vZ2xlLmNvbT6J
-AT8EEwECACkFAlDsSLECGy8FCQeGH4AHCwkIBwMCAQYVCAIJCgsEFgIDAQIeAQIX
-gAAKCRANhinnSRLCsOdIB/4tUVShup2NHXJ9acCah8TuEN4GmN9dBiD9YsGW66SR
-/ptY0Gn9XExl2wbmQW+7TQg3QUGv8uffwYLtnMwnmCp/WwgE+uSnRmcENxa9GuTu
-PLlURKKGK0C9ljTAHwXtPcIYxPNN3BT4VB56ME1DTBRCgEvudaNSANs8/kT88kE2
-eMC7x0Uo3/P38Ob8XSOfR8c6G6nSz6jILcRBXZTPNNK4svyqF5XHIru65d3/0+mr
-bpfcDLcUQYms0MpPmO1RCHLZWwJLsPUIxNwGGnKJc8/RNEvQinK+Ap0cf+PGUQSX
-PhB6Z81ROFIVToEVZslgSiL+u4Tc7zXDfDQDY4HeLY2t
-=w/CG
------END PGP PUBLIC KEY BLOCK-----
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/783e6382/docs/_extra/meta/contact.include.md
----------------------------------------------------------------------
diff --git a/docs/_extra/meta/contact.include.md b/docs/_extra/meta/contact.include.md
deleted file mode 100644
index e0d1e4b..0000000
--- a/docs/_extra/meta/contact.include.md
+++ /dev/null
@@ -1,9 +0,0 @@
-
-Contact us on the [brooklyn mailing list](https://mail-archives.apache.org/mod_mbox/incubator-brooklyn-dev/).
-
-Additionally look for us on:
-
-* **IRC**: #brooklyncentral ([IRC??](/meta/irc.html))
-* **Twitter**: @brooklyncentral #brooklyncentral
-
-We'd love to hear from you!
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/783e6382/docs/_extra/meta/contact.md
----------------------------------------------------------------------
diff --git a/docs/_extra/meta/contact.md b/docs/_extra/meta/contact.md
deleted file mode 100644
index 83de32f..0000000
--- a/docs/_extra/meta/contact.md
+++ /dev/null
@@ -1,7 +0,0 @@
----
-layout: website-normal
-title: Contact
-toc: /guide/toc.json
----
-
-{% readj contact.include.md %}
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/783e6382/docs/_extra/meta/irc.md
----------------------------------------------------------------------
diff --git a/docs/_extra/meta/irc.md b/docs/_extra/meta/irc.md
deleted file mode 100644
index 2cc5b97..0000000
--- a/docs/_extra/meta/irc.md
+++ /dev/null
@@ -1,31 +0,0 @@
----
-layout: website-normal
-title: IRC
-toc: /guide/toc.json
----
-
-IRC is a basic group chat system used by many open source projects to enable developers to
-collaborate and to help users communicate and support each other. Brooklyn has an IRC
-channel where users and developers hang out.
-
-## Getting Help On IRC
-
-When you connect to the Brooklyn IRC channel, say Hi and then ask your question. It may
-take a little while for someone to see and respond to your question. (Be
-patient if you don't get an instant answer - unless there's already a conversation
-happening folk will probably not have their eyes on the channel.)
-
-You may want to do other things while you wait, like reviewing the [brooklyn mailing list](https://mail-archives.apache.org/mod_mbox/incubator-brooklyn-dev/)
-lists to see if anyone has had the same issue before.
-
-## Brooklyn IRC Channel
-
-* **IRC Server:** irc.freenode.net
-* **Channel/Room:** #brooklyncentral
-* **Port:** 6667 (Default)
-
-If you are new to IRC, there is a web interface at [webchat.freenode.net](http://webchat.freenode.net/?channels=brooklyncentral)
-but you may prefer to checkout the [Wikipedia IRC article](http://en.wikipedia.org/wiki/IRC#Client_software)
-for an IRC application.
-
-You can find more information about using IRC at [irchelp.org](http://www.irchelp.org/).
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/783e6382/docs/_extra/meta/toc.json
----------------------------------------------------------------------
diff --git a/docs/_extra/meta/toc.json b/docs/_extra/meta/toc.json
deleted file mode 100644
index f01fa8e..0000000
--- a/docs/_extra/meta/toc.json
+++ /dev/null
@@ -1,8 +0,0 @@
-[
-{ "title": "Versions",
- "file": "{{ site.path.guide }}/meta/versions.html" },
-{ "title": "Verify",
- "file": "{{ site.path.guide }}/meta/verify.html" },
-{ "title": "Contact",
- "file": "{{ site.path.guide }}/meta/contact.html" }
-]
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/783e6382/docs/_extra/meta/versions.md
----------------------------------------------------------------------
diff --git a/docs/_extra/meta/versions.md b/docs/_extra/meta/versions.md
deleted file mode 100644
index aeea4ef..0000000
--- a/docs/_extra/meta/versions.md
+++ /dev/null
@@ -1,110 +0,0 @@
----
-layout: website-normal
-title: Versions
-toc: /guide/toc.json
----
-
-<!--- display which version we are using, based on where it is written -->
-
-### Brooklyn v{{ site.brooklyn-stable-version }}
-
-
-{% if site.server %}
-> **Server (debug) mode detected.**
-
-> *Links to other versions on this page and others will likely not work when running in server/debug mode.
-Files must be copied to the brooklyncentral.github.com repo for these links to resolve correctly.*
-
-> *Debug page generated {{ site.time }}*
-{% endif %}
-
-
-{% if site.brooklyn-version contains 'SNAPSHOT' %}
-<!--- snapshot version -->
-
- {% if site.path.guide == '' %}
-
-<!--- current version (served off root of site) is snapshot (unusual) -->
-
-This is the documentation for the current snapshot version of Brooklyn,
-generated {{ site.time | date_to_string }}.
-
- {% else %}
-
-<!--- archive docs -->
-
-This is the documentation for a snapshot version of Brooklyn,
-generated {{ site.time | date_to_string }}.
-
-[View current documentation here.](/meta/versions.html)
-
-
- {% endif %}
-
-NB: "Snapshot" means it is the code at a point in time,
-and that a reference to this version {{ site.brooklyn-version }}
-may resolve to different code at a different point in time.
-Where possible it is preferable to develop against a GA version
-rather than a shapshot.
-
-{% else %}
-<!--- not snapshot -->
-
- {% if site.path.guide == '' %}
-
-<!--- current version (served off root of site) -->
-
-This is the documentation for the latest stable version of Brooklyn,
-generated {{ site.time | date_to_string }}.
-Other versions with documentation available are listed below.
-
- {% else %}
-
-<!--- archive version -->
-
-This is the archived documentation for Brooklyn {{ site.brooklyn-version }}
-(generated {{ site.time }}, archived under {{ site.path.guide }}).
-
-[View current documentation here.](/meta/versions.html)
-
- {% endif %}
-{% endif %}
-
-
-### Version History
-
-* **[0.7.0-SNAPSHOT (master)](/v/0.7.0-SNAPSHOT)**: since 0.6.0, lots of work on yaml, persistence, policies, and more supported systems
-
-* **[0.7.0](/v/0.7.0-M1/)**: most recent milestone release
-
-* **[0.6.0](/v/0.6.0/)**: use of spec objects, chef and windows support, more clouds (Nov 2013)
-
-* **[0.5.0](/v/0.5.0/)**: includes new JS GUI and REST API, rebind/persistence support, cleaner model and naming conventions, more entities (May 2013)
-
-* **[0.4.0](/v/0.4.0/)**: initial public GA release of Brooklyn to Maven Central, supporting wide range of entities and examples (Jan 2013)
-
-Note: To prevent accidentally referring to out-of-date information,
-a banner is displayed when accessing specific versions from the archive.
-You may
-<a href="#" onclick="set_user_versions_all();">disable all warnings</a> or
-<a href="#" onclick="clear_user_versions();">re-enable all warnings</a>.
-
-
-### Versioning
-
-Brooklyn uses the [semantic versioning](http://semver.org/) guidelines. Releases will be numbered with the following format:
-
-`Brooklyn <major>.<minor>.<patch>`
-
-Breaking backward compatibility increments the `<major>` version.
-New additions without breaking backward compatibility ups the `<minor>` version.
-Bug fixes and misc changes bumps the `<patch>` version.
-New major and minor releases zero the less significant counters.
-
-Additionally, Brooklyn's release process include Snapshots, Milestones and Release Candidates.
-
-A Snapshot (`-SNAPSHOT`) is the bleeding edge. This will not be stable.
-
-Milestone versions (`-Mn`) are frozen snapshots. Some code features may be stable, but the documentation and examples may not be complete.
-
-A Release Candidate (`-rc.n`) is a just-about-ready version. Release candidates are tested against our acceptance criteria, and qualifying builds are promoted as final.
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/783e6382/docs/_extra/standards.md
----------------------------------------------------------------------
diff --git a/docs/_extra/standards.md b/docs/_extra/standards.md
deleted file mode 100644
index ab6a2e3..0000000
--- a/docs/_extra/standards.md
+++ /dev/null
@@ -1,15 +0,0 @@
----
-layout: website-normal
-title: Code Standards
-toc: /guide/toc.json
----
-
-Without being too restrictive about how you have to code as part of Brooklyn,
-there are some style points that really make life easier when sharing code
-among ourselves:
-
-* Use spaces (not tabs!) with 4 spaces indentation
-* Keep line length <=128
-* Don't reformat code or organize imports unless there's very good
- reason (this makes history and merges much harder)
-
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/783e6382/docs/_includes/base-head.html
----------------------------------------------------------------------
diff --git a/docs/_includes/base-head.html b/docs/_includes/base-head.html
index 2cdc852..7286eb7 100644
--- a/docs/_includes/base-head.html
+++ b/docs/_includes/base-head.html
@@ -14,3 +14,4 @@
<script src="{% dependency_url jquery.js %}"></script>
<script src="{% dependency_url bootstrap.js %}"></script>
+<script type="text/javascript" src="{{ site.path.style }}/deps/jquery.cookie.js"></script>
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/783e6382/docs/_layouts/base.html
----------------------------------------------------------------------
diff --git a/docs/_layouts/base.html b/docs/_layouts/base.html
index a456173..6c51578 100644
--- a/docs/_layouts/base.html
+++ b/docs/_layouts/base.html
@@ -24,6 +24,8 @@ under the License.
{{ content }}
+<script src="//cdnjs.cloudflare.com/ajax/libs/zeroclipboard/1.3.1/ZeroClipboard.min.js"></script>
+
<script language="JavaScript" type="application/javascript">
fix_padding_function = function () {
$('body').css('padding-top', parseInt($('#header').css("height"))+10);
@@ -62,6 +64,121 @@ $(function () {
linkifyAnchors(level, contentBlock);
}
});
+
+<!-- Clipboard support -->
+ ZeroClipboard.config({ moviePath: '//cdnjs.cloudflare.com/ajax/libs/zeroclipboard/1.3.1/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 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 );
+ });
+ });
+});
+
+<!-- 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) -->
+{% comment %}
+TODO insert the warning html at generation-time (jekyll) rather than runtime (JS)
+{% endcomment %}
+{% if page.path contains 'guide/' %}
+ $(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>You are browsing the archive site for version <strong>"+thisversion+"</strong>.</p>";
+ if (thisversion.indexOf("SNAPSHOT") >= 0) {
+ msg += "<p>Note that SNAPSHOT versions have not been voted on and are not endorsed by the Apache Software Foundation.</p>";
+ msg += "<p>Do you understand and accept the risks?</p>";
+ } else {
+ msg += "<p>Is this deliberate?</p>";
+ }
+ msg += "<center><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, take me to the latest version guide</a>";
+ msg += "<a href = '{{ site.page.website }}/meta/versions.html'>Show all versions</a>";
+ msg += "</p></center>"
+
+ $('#page_notes').html(msg);
+ $('#page_notes').fadeIn('slow');
+ }
+ }
+ });
+{% endif %}
+ 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>
</body>
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/783e6382/docs/_layouts/website-normal.html
----------------------------------------------------------------------
diff --git a/docs/_layouts/website-normal.html b/docs/_layouts/website-normal.html
index 3a7e9b9..a89bb91 100644
--- a/docs/_layouts/website-normal.html
+++ b/docs/_layouts/website-normal.html
@@ -25,6 +25,7 @@ layout: website-base
<div class="container" id="main_container">
<div class="row">
<div class="col-md-9" id="content_container">
+ <div id="page_notes"></div>
<h1>{{ page.title }}</h1>
{{ content }}
</div>
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/783e6382/docs/guide/start/running.md
----------------------------------------------------------------------
diff --git a/docs/guide/start/running.md b/docs/guide/start/running.md
index 4053e0c..17e3d934 100644
--- a/docs/guide/start/running.md
+++ b/docs/guide/start/running.md
@@ -94,10 +94,10 @@ $ brooklyn launch
Brooklyn will output the address of the management interface:
-
-`INFO Starting brooklyn web-console on loopback interface because no security config is set`
-
-`INFO Started Brooklyn console at http://127.0.0.1:8081/, running classpath://brooklyn.war and []`
+<pre>
+INFO Starting brooklyn web-console on loopback interface because no security config is set
+INFO Started Brooklyn console at http://127.0.0.1:8081/, running classpath://brooklyn.war and []
+</pre>
### Next
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/783e6382/docs/style/css/base.scss
----------------------------------------------------------------------
diff --git a/docs/style/css/base.scss b/docs/style/css/base.scss
index 01a7122..6d2b9fa 100644
--- a/docs/style/css/base.scss
+++ b/docs/style/css/base.scss
@@ -135,9 +135,11 @@ a[id]:empty, a[name]:empty {
opacity: 0;
font-size: 0.8em;
+/* not using -- but this is cool!
-webkit-transition: opacity 0.2s ease-in-out 0.1s;
-moz-transition: opacity 0.2s ease-in-out 0.1s;
-ms-transition: opacity 0.2s ease-in-out 0.1s;
+*/
}
h2:hover .header-link,
h3:hover .header-link,
@@ -438,10 +440,121 @@ code {
padding: 4px 4px 2px 4px;
border-radius: 3px;
}
-.highlight { background-color:$code_bg_color; } /* clipboard icon should have the same background color as the code */
.nowrap { @include nowrap(); }
+.highlight { background-color:$code_bg_color; } /* clipboard icon should have the same background color as the code */
+
+.highlight .clipboard_button { display: none; }
+.highlight:hover .clipboard_button { display: inherit; }
+.clipboard_button.zeroclipboard-is-hover { display: inherit; }
+
+.clipboard_container { float: right; padding: 8px; }
+.clipboard_button:before {
+ // fa-copy
+ content: "\f0c5";
+}
+.clipboard_button {
+ font-size: 18px;
+ transform: translateY(-2px);
+ color: $vibrant_fg_green;
+}
+.clipboard_button:hover, .clipboard_button.zeroclipboard-is-hover {
+ color: $a_hover_color;
+ cursor: pointer; cursor: hand;
+}
+.clipboard_button.zeroclipboard-is-active .on-active {
+ display: inherit;
+}
+.clipboard_button .on-active {
+ display: none;
+ margin-top: -20px;
+ height: 0;
+ width: 0;
+ overflow-x: visible;
+ overflow-y: visible;
+ position: relative;
+ top: -30px;
+}
+.clipboard_button .on-active > div {
+ background-color: $white_dd;
+ border: 1px solid $gray_aa;
+ font-size: 75%;
+ font-weight: normal;
+ left: -50%;
+ color: $blackish;
+ width: auto;
+ display: inline-block;
+ @include nowrap();
+ padding: 3px 7px;
+ transform: translateX(-50%);
+}
+
+
+/* SEARCH
+ ----------------------------------------------------------------------- */
+
+div.search_right {
+ float: right;
+ transform: translateY(-12px);
+ padding-right: 5%;
+ padding-bottom: 18px;
+ font-size: 75%;
+ .searchform {
+ width: 240px;
+ margin: 0;
+ padding: 5px 5px 0 0;
+ overflow: hidden;
+ text-align: right;
+ }
+ .searchinput {
+ width: 227px;
+ background: #ffffff;
+ border: 1px solid #b1b7c2;
+ -moz-border-radius: 2px;
+ border-radius: 2px;
+ color: #c8ccd5;
+ padding: 3px;
+ }
+ .searchinput:focus {
+ color: $blackish;
+ }
+}
+
+
+/* ARCHIVE PAGE WARNING
+ ----------------------------------------------------------------------- */
+
+#page_notes {
+ display: none;
+ background-color: #4D9D3A;
+ border: 3px solid orange;
+ -moz-border-radius: 8px;
+ border-radius: 8px;
+ padding: 0.3em;
+ padding-left: 0.75em;
+ margin-top: 24px;
+ margin-bottom: -24px;
+
+ div.warning {
+ background-color: #F8CB9C;
+ border: 1px solid #FFAB7C;
+ padding-left: 0.75em;
+ -moz-border-radius: 8px;
+ border-radius: 8px;
+ }
+ .warning_banner_image img {
+ width: 64px; padding-top: 8px; padding-right: 12px;
+ float: left;
+ }
+ p { line-height: 100%; color: white; }
+ p.warning_banner_buttons {padding-right: 24px; }
+ p.warning_banner_buttons a, #page_notes p.warning_banner_buttons a:visited {
+ color: orange; font-weight: bold; padding-right: 1em; text-decoration: none; }
+ p.warning_banner_buttons a:hover { color: #FFC31E; font-weight: bold; }
+}
+
+
/* LANDING PAGE
----------------------------------------------------------------------- */
@@ -479,6 +592,7 @@ div.feather.landing {
}
}
+
/* YAML EXPLAINED
----------------------------------------------------------------------- */
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/783e6382/docs/website/developers/code-standards.md
----------------------------------------------------------------------
diff --git a/docs/website/developers/code-standards.md b/docs/website/developers/code-standards.md
new file mode 100644
index 0000000..4d18ca9
--- /dev/null
+++ b/docs/website/developers/code-standards.md
@@ -0,0 +1,14 @@
+---
+layout: website-normal
+title: Code Standards
+---
+
+Without being too restrictive about how you have to code as part of Brooklyn,
+there are some style points that really make life easier when sharing code
+among ourselves:
+
+* Use spaces (not tabs!) with 4 spaces indentation
+* Keep line length <=128
+* Don't reformat code or organize imports unless there's very good
+ reason (this makes history and merges much harder)
+
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/783e6382/docs/website/developers/index.md
----------------------------------------------------------------------
diff --git a/docs/website/developers/index.md b/docs/website/developers/index.md
index 8c1af7d..2edae18 100644
--- a/docs/website/developers/index.md
+++ b/docs/website/developers/index.md
@@ -5,6 +5,7 @@ children:
- how-to-contribute.md
- /guide/dev/
- committers/
+- code-standards.md
- { link: 'http://github.com/apache/incubator-brooklyn', title: 'GitHub' }
- { link: 'https://issues.apache.org/jira/browse/BROOKLYN', title: 'Bug Tracker (JIRA)' }
---
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/783e6382/docs/website/meta/sitemap.md
----------------------------------------------------------------------
diff --git a/docs/website/meta/sitemap.md b/docs/website/meta/sitemap.md
index 1341959..7411976 100644
--- a/docs/website/meta/sitemap.md
+++ b/docs/website/meta/sitemap.md
@@ -3,10 +3,15 @@ layout: website-normal
title: Site Map
---
-<!-- TODO this is very much work in progress -->
-
<div class="sitemap">
+<div class="search_right">
+<form method="get" id="simple_google" class="searchform" action="http://www.google.com/search">
+ <input type="text" class="searchinput" name="brooklyn-search" placeholder="Google site search: type & hit enter">
+ <input type="hidden" name="q" value="">
+ </form>
+</div>
+
{% assign visited = "" | split: "|" %}
{% assign site_items = "" | split: "|" %}
<ul>
@@ -15,3 +20,6 @@ title: Site Map
{% include sitemap-item.html %}
{% endfor %}
</ul>
+
+</div>
+