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/09 16:34:36 UTC

[07/44] incubator-brooklyn git commit: Add a versions page

Add a versions page


Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/6da2ea96
Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/6da2ea96
Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/6da2ea96

Branch: refs/heads/master
Commit: 6da2ea96a5f34375a773274fa5abb9a5535a9bdd
Parents: 25cc4c8
Author: Alex Heneveld <al...@cloudsoftcorp.com>
Authored: Tue Dec 23 17:30:13 2014 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
Committed: Wed Jan 7 14:20:39 2015 +0000

----------------------------------------------------------------------
 docs/README.md                | 19 ++++++++--
 docs/_config.yml              |  2 ++
 docs/guide/meta/versions.md   |  5 +--
 docs/website/meta/sitemap.md  | 19 ++++++++++
 docs/website/meta/versions.md | 71 ++++++++++++++++++++++++++++++++++++++
 docs/website/sitemap.md       | 19 ----------
 6 files changed, 110 insertions(+), 25 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/6da2ea96/docs/README.md
----------------------------------------------------------------------
diff --git a/docs/README.md b/docs/README.md
index 4fb6b5d..4d7c6d5 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -160,6 +160,22 @@ but with the correct file structure, is:
     _build/build.sh test-both --skip-javadoc --serve
 
 
+Preparing for a Release
+-----------------------
+
+When doing a release and changing versions:
+
+* Before branching:
+  * Change the `brooklyn-stable-version` variable in `_config.yml`
+  * Update `website/meta/versions.md` with a bit of info on this release
+*  In the branch, with `change-version.sh` run (e.g. from `N.SNAPSHOT` to `N`)
+  * Ensure the `guide/start/release-notes.md` file is current
+  * Build and publish `website-root`, `guide-latest`, and `guide-version`
+* In master, with `change-version.sh` run (e.g. to `N+1-SNAPSHOT`)
+  * Clear old stuff in the `guide/start/release-notes.md` file
+  * Optionally build and public `guide-version`
+ 
+
 Publishing the Website and Guide
 --------------------------------
 
@@ -266,5 +282,4 @@ Archived versions are kept under `/v/` in the website.  New versions should be a
 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.
 
-A list of available versions also needs to be updated.  This is referenced from the `website`.
-<!-- TODO: where -->
+A list of available versions is in `website/meta/versions.md`.

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/6da2ea96/docs/_config.yml
----------------------------------------------------------------------
diff --git a/docs/_config.yml b/docs/_config.yml
index c889861..d20078e 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -39,6 +39,8 @@ dependency_urls:
 # These files should not be included in the final build (in addition to _* contents)
 exclude: ['/Gemfile*','/README.md']
 
+brooklyn-stable-version: 0.7.0-M2
+
 brooklyn-version: 0.7.0-SNAPSHOT # BROOKLYN_VERSION
 brooklyn-snapshot-git-branch: master   # if line above is SNAPSHOT this should point to corresponding git branch (e.g. master, 0.4)
 

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/6da2ea96/docs/guide/meta/versions.md
----------------------------------------------------------------------
diff --git a/docs/guide/meta/versions.md b/docs/guide/meta/versions.md
index 4ce1256..57e64a4 100644
--- a/docs/guide/meta/versions.md
+++ b/docs/guide/meta/versions.md
@@ -4,12 +4,9 @@ title: Versions
 toc: /guide/toc.json
 ---
 
-**TODO: page needs overhaul with separate new main site**
-
-
 <!--- display which version we are using, based on where it is written -->
 
-### Brooklyn v{{ site.brooklyn-version }}
+### Brooklyn v{{ site.brooklyn-stable-version }}
 
 
 {% if site.server %} 

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/6da2ea96/docs/website/meta/sitemap.md
----------------------------------------------------------------------
diff --git a/docs/website/meta/sitemap.md b/docs/website/meta/sitemap.md
new file mode 100644
index 0000000..efff2b2
--- /dev/null
+++ b/docs/website/meta/sitemap.md
@@ -0,0 +1,19 @@
+---
+layout: website-normal
+title: Site Map
+---
+
+<!-- TODO this is very much work in progress -->
+
+Site map is:
+
+{% for item in site.data.menu %}
+&nbsp;&nbsp;&nbsp; * {{ item['title_in_menu'] }} / {{ item.data['title'] }} - {{ item.data }}<br/>
+  {% for item2 in item['menu'] %}
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; * {{ item2['title_in_menu'] }} / {{ item2['path'] }} / {{ item2['link'] }}<br/>
+    {% for item3 in item2['menu'] %}
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; * {{ item3['title_in_menu'] }} / {{ item3['path'] }} / {{ item3['breadcrumbs'] }}<br/>
+    {% endfor %}
+  {% endfor %}
+{% endfor %}
+

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/6da2ea96/docs/website/meta/versions.md
----------------------------------------------------------------------
diff --git a/docs/website/meta/versions.md b/docs/website/meta/versions.md
new file mode 100644
index 0000000..949e6f6
--- /dev/null
+++ b/docs/website/meta/versions.md
@@ -0,0 +1,71 @@
+---
+layout: website-normal
+title: Versions
+---
+
+### Current Version: {{ site.brooklyn-stable-version }}
+
+The current stable version of Brooklyn is {{ site.brooklyn-stable-version }}:
+
+* [Download]({{ site.path.website }}/download.md)
+* [User Guide]({{ site.path.guide }}/)
+* [Release Notes]({{ site.path.guide }}/start/release-notes.md)
+
+This documentation was generated {{ site.time | date_to_string }}.
+
+
+### Version History
+
+Apache versions:
+
+* **[0.7.0-SNAPSHOT](/v/0.7.0-SNAPSHOT/)**: bleeding-edge (not voted on or endorsed by Apache!)
+
+* **[0.7.0-M2](/v/0.7.0-M2/)**: YAML, persistence, Chef, Windows, Docker. The first Apache release! (Dec 2014)
+
+
+The versions below were made prior to joining the Apache Incubator, 
+therefore **they are not endorsed by Apache** and are not hosted by Apache or their mirrors. 
+You can obtain the source code by [inspecting the branches of the pre-Apache GitHub repository](https://github.com/brooklyncentral/brooklyn/branches/stale) 
+and binary releases by [querying Maven Central for io.brooklyn:brooklyn.dist](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22io.brooklyn%22%20AND%20a%3A%22brooklyn-dist%22).
+
+* **[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 content from specific versions in 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 follows [semantic versioning](http://semver.org/) with a leading `0.` qualifier:
+
+    0.<major>.<minor>[.<patch>]-<qualifier>
+
+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.
+
+From time to time, the Brooklyn project will make snapshots, milestone releases, and other qualified versions available,
+using the following conventions:
+
+* Milestone versions (`-M<n>`) have been voted on and have been through some QA,
+  but have not had the extensive testing as is done on a release.
+
+* Snapshot (`-SNAPSHOT`) is the bleeding edge.
+  With good test coverage these builds are usually healthy, 
+  but they have not been through QA or voted on.
+
+* Nightly builds (`-N<date>`) represent a snapshot which has
+  been given a permanent version number, typically for use by other projects.
+  The same caveats as for snapshot releases apply (no QA or Apache vote). 
+
+* Release Candidate builds (`-RC<n>`) are made in the run-up to a release;
+  these should not normally be used except for deciding whether to cut a release.
+

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/6da2ea96/docs/website/sitemap.md
----------------------------------------------------------------------
diff --git a/docs/website/sitemap.md b/docs/website/sitemap.md
deleted file mode 100644
index efff2b2..0000000
--- a/docs/website/sitemap.md
+++ /dev/null
@@ -1,19 +0,0 @@
----
-layout: website-normal
-title: Site Map
----
-
-<!-- TODO this is very much work in progress -->
-
-Site map is:
-
-{% for item in site.data.menu %}
-&nbsp;&nbsp;&nbsp; * {{ item['title_in_menu'] }} / {{ item.data['title'] }} - {{ item.data }}<br/>
-  {% for item2 in item['menu'] %}
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; * {{ item2['title_in_menu'] }} / {{ item2['path'] }} / {{ item2['link'] }}<br/>
-    {% for item3 in item2['menu'] %}
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; * {{ item3['title_in_menu'] }} / {{ item3['path'] }} / {{ item3['breadcrumbs'] }}<br/>
-    {% endfor %}
-  {% endfor %}
-{% endfor %}
-