tidies to download instructions remove usages of site.data.brooklyn-version in favour of site.brooklyn-stable-version, simplify main download page, linking to other versions, and fixing links (some were broken, and us/eu ones caused certificate errors so i've taken them out)
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/772ea293 Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/772ea293 Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/772ea293 Branch: refs/heads/master Commit: 772ea293529204bfaa748fc743259fa576830bb4 Parents: e3b40c4 Author: Alex Heneveld <[email protected]> Authored: Tue Jan 20 15:57:24 2015 +0000 Committer: Alex Heneveld <[email protected]> Committed: Tue Jan 20 16:04:54 2015 +0000 ---------------------------------------------------------------------- docs/_config.yml | 3 + docs/_plugins/brooklyn_metadata.rb | 4 +- docs/guide/misc/download.md | 8 ++- docs/guide/misc/index.md | 2 +- docs/guide/start/_my-web-cluster.yaml | 2 +- docs/guide/start/running.md | 6 +- docs/style/css/_basic.scss | 5 ++ docs/website/documentation/install-on-server.md | 8 +-- docs/website/download/index.md | 23 +++---- docs/website/download/verify.md | 69 +++++++++++--------- docs/website/meta/versions.md | 4 +- 11 files changed, 74 insertions(+), 60 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/772ea293/docs/_config.yml ---------------------------------------------------------------------- diff --git a/docs/_config.yml b/docs/_config.yml index 121dbad..10a5d5a 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -44,6 +44,9 @@ exclude: ['/Gemfile*','/README.md'] sass: sass_dir: style/css +# used for the "verify" page +brooklyn-stable-versions: [ 0.7.0-M2-incubating ] + brooklyn-stable-version: 0.7.0-M2-incubating brooklyn-version: 0.7.0-SNAPSHOT # BROOKLYN_VERSION http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/772ea293/docs/_plugins/brooklyn_metadata.rb ---------------------------------------------------------------------- diff --git a/docs/_plugins/brooklyn_metadata.rb b/docs/_plugins/brooklyn_metadata.rb index c50f844..cb2ba2e 100644 --- a/docs/_plugins/brooklyn_metadata.rb +++ b/docs/_plugins/brooklyn_metadata.rb @@ -61,8 +61,10 @@ module BrooklynMetadata "is_snapshot" => is_snapshot, "url" => url_set } + # config is preferred of data, because you can write just {{ site.brooklyn.xxx }}, - # but some places reference site.data.brooklyn + # also note {{ site.brooklyn-version }} v {{ site.brooklyn-stable-version }} from _config.yml + # but some places referenced site.data.brooklyn (i think these have been remove) site.data['brooklyn'] = site.config['brooklyn'] end http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/772ea293/docs/guide/misc/download.md ---------------------------------------------------------------------- diff --git a/docs/guide/misc/download.md b/docs/guide/misc/download.md index 02bad9e..c79ef16 100644 --- a/docs/guide/misc/download.md +++ b/docs/guide/misc/download.md @@ -4,11 +4,15 @@ title: Downloads --- {% include fields.md %} -First time user? The [getting started]({{ site.path.guide }}/start/) guide will walk you through downloading Brooklyn and running an example. +**Brooklyn in Apache has not yet made an official clean binary release. +The downloads on this page have not been voted on and should be used at your own risk. +Additionally some links on this page may not work until those builds have been officially released. +For more information, see the [main download page]({{ site.path.website }}/download/).** + ## Download Version {{ site.brooklyn-version }} -<table> +<table class="table"> <tr> <th style='text-align:left'>Download</th> <th style='text-align:left'>File/Format</th> http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/772ea293/docs/guide/misc/index.md ---------------------------------------------------------------------- diff --git a/docs/guide/misc/index.md b/docs/guide/misc/index.md index 1f80f3f..9639cbf 100644 --- a/docs/guide/misc/index.md +++ b/docs/guide/misc/index.md @@ -17,4 +17,4 @@ Further documentation specific to this version of Brooklyn includes: * [{{ item.title_in_menu }}]({{ item.url }}) {% endfor %} -Also see the [other versions]({{ path.guide }}/meta/versions.html) or [general documentation]({{ path.guide }}/documentation/). +Also see the [other versions]({{ site.path.website }}/meta/versions.html) or [general documentation]({{ site.path.website }}/documentation/). http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/772ea293/docs/guide/start/_my-web-cluster.yaml ---------------------------------------------------------------------- diff --git a/docs/guide/start/_my-web-cluster.yaml b/docs/guide/start/_my-web-cluster.yaml index 7862c6b..166c497 100644 --- a/docs/guide/start/_my-web-cluster.yaml +++ b/docs/guide/start/_my-web-cluster.yaml @@ -7,7 +7,7 @@ services: - type: brooklyn.entity.webapp.ControlledDynamicWebAppCluster name: My Web brooklyn.config: - wars.root: http://search.maven.org/remotecontent?filepath=io/brooklyn/example/brooklyn-example-hello-world-sql-webapp/{{ site.data.brooklyn.version }}/brooklyn-example-hello-world-sql-webapp-{{ site.data.brooklyn.version }}.war + wars.root: http://search.maven.org/remotecontent?filepath=io/brooklyn/example/brooklyn-example-hello-world-sql-webapp/0.6.0/brooklyn-example-hello-world-sql-webapp-0.6.0.war java.sysprops: brooklyn.example.db.url: > $brooklyn:formatString("jdbc:%s%s?user=%s\\&password=%s", http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/772ea293/docs/guide/start/running.md ---------------------------------------------------------------------- diff --git a/docs/guide/start/running.md b/docs/guide/start/running.md index 965272d..6de22c6 100644 --- a/docs/guide/start/running.md +++ b/docs/guide/start/running.md @@ -21,15 +21,15 @@ Expand the `tar.gz` archive: {% if brooklyn_version contains 'SNAPSHOT' %} {% highlight bash %} -$ tar -zxf brooklyn-dist-{{ site.data.brooklyn.version }}-timestamp-dist.tar.gz +$ tar -zxf brooklyn-dist-{{ site.brooklyn-version }}-timestamp-dist.tar.gz {% endhighlight %} {% else %} {% highlight bash %} -$ tar -zxf brooklyn-{{ site.data.brooklyn.version }}-dist.tar.gz +$ tar -zxf brooklyn-{{ site.brooklyn-version }}-dist.tar.gz {% endhighlight %} {% endif %} -This will create a `brooklyn-{{ site.data.brooklyn.version }}` folder. +This will create a `brooklyn-{{ site.brooklyn-version }}` folder. **Note**: You'll need a Java JRE or SDK installed (version 6 or later), as Brooklyn is Java under the covers. http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/772ea293/docs/style/css/_basic.scss ---------------------------------------------------------------------- diff --git a/docs/style/css/_basic.scss b/docs/style/css/_basic.scss index 05fe469..d8c9235 100644 --- a/docs/style/css/_basic.scss +++ b/docs/style/css/_basic.scss @@ -55,3 +55,8 @@ a:hover {text-decoration: none; color: $a_hover_color;} margin-left: -1em; } } +.table > thead > tr > th, .table > tbody > tr > th, .table > tfoot > tr > th, .table > thead > tr > td, .table > tbody > tr > td, .table > tfoot > tr > td { + // extend bootstrap with a bottom border on table items; + // these get collapsed so not sure why bootstrap does weirdness where there's no bottom border + border-bottom: 1px solid $white_dd; +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/772ea293/docs/website/documentation/install-on-server.md ---------------------------------------------------------------------- diff --git a/docs/website/documentation/install-on-server.md b/docs/website/documentation/install-on-server.md index defef7e..67dc6da 100644 --- a/docs/website/documentation/install-on-server.md +++ b/docs/website/documentation/install-on-server.md @@ -61,20 +61,20 @@ Expand the `tar.gz` archive: {% if brooklyn_version contains 'SNAPSHOT' %} {% highlight bash %} -$ tar -zxf brooklyn-dist-{{ site.data.brooklyn.version }}-timestamp-dist.tar.gz +$ tar -zxf brooklyn-dist-{{ site.brooklyn-stable-version }}-timestamp-dist.tar.gz {% endhighlight %} {% else %} {% highlight bash %} -$ tar -zxf brooklyn-{{ site.data.brooklyn.version }}-dist.tar.gz +$ tar -zxf brooklyn-{{ site.brooklyn-stable-version }}-dist.tar.gz {% endhighlight %} {% endif %} -This will create a `brooklyn-{{ site.data.brooklyn.version }}` folder. +This will create a `brooklyn-{{ site.brooklyn-stable-version }}` folder. Let's setup some paths for easy commands. {% highlight bash %} -$ cd brooklyn-{{ site.data.brooklyn.version }} +$ cd brooklyn-{{ site.brooklyn-stable-version }} $ BROOKLYN_DIR="$(pwd)" $ export PATH=$PATH:$BROOKLYN_DIR/bin/ {% endhighlight %} http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/772ea293/docs/website/download/index.md ---------------------------------------------------------------------- diff --git a/docs/website/download/index.md b/docs/website/download/index.md index 33f5d16..3008502 100644 --- a/docs/website/download/index.md +++ b/docs/website/download/index.md @@ -2,39 +2,32 @@ layout: website-normal title: Download children: -- { path: verify.md } +- verify.md +- ../meta/versions.md --- ## Latest Brooklyn Source Code Release -[Download Apache Brooklyn {{ site.data.brooklyn.version }} from our mirror sites](https://www.apache.org/dyn/closer.cgi/incubator/brooklyn/{{ site.data.brooklyn.version }}/apache-brooklyn-{{ site.data.brooklyn.version }}.tar.gz) +[Download Apache Brooklyn {{ site.brooklyn-stable-version }} from our mirror sites](https://www.apache.org/dyn/closer.cgi/incubator/brooklyn/{{ site.brooklyn-stable-version }}/apache-brooklyn-{{ site.brooklyn-stable-version }}.tar.gz) You can also verify that you build has not been tampered with by [verifying the hashes and signatures](verify.html). ## Build the Binary Package -We do not yet have an official binary package for Apache Brooklyn. We plan to address this in our next release. However, -it is relatively easy to create the binary package from source code, if you have a working JDK of at least version 6, -and Maven 3. +We do not yet have an official binary package for Apache Brooklyn. We plan to address this in our next release. -Unpack `apache-brooklyn-{{ site.data.brooklyn.version }}.tar.gz` and then execute this command in the `apache-brooklyn-{{ site.data.brooklyn.version }}` folder: +However, it is relatively easy to create the binary package from source code, if you have a working recent JDK and Maven 3. + +Unpack `apache-brooklyn-{{ site.brooklyn-stable-version }}.tar.gz` and then execute this command in the `apache-brooklyn-{{ site.brooklyn-stable-version }}` folder: {% highlight bash %} mvn clean install -DskipTests {% endhighlight %} -You can then find the binary distribution in the folder `usage/dist/target/brooklyn-dist`, or archived as `usage/dist/target/brooklyn-{{ site.data.brooklyn.version }}-dist.tar.gz`. +You should then find the binary distribution in the folder `usage/dist/target/brooklyn-dist`, or archived as `usage/dist/target/brooklyn-{{ site.brooklyn-stable-version }}-dist.tar.gz`. ## Get Started! Take a look at the [Get Started]({{ site.path.guide }}/start/running.html) page! - - -## Previous Versions - -Versions of Brooklyn prior to 0.7.0-M2 were all 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). http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/772ea293/docs/website/download/verify.md ---------------------------------------------------------------------- diff --git a/docs/website/download/verify.md b/docs/website/download/verify.md index 0feb4db..df0a516 100644 --- a/docs/website/download/verify.md +++ b/docs/website/download/verify.md @@ -3,48 +3,47 @@ layout: website-normal title: Verify the Integrity of Downloads --- -It is essential for security that you verify the integrity of the downloaded files using their PGP signatures or SHA-1 checksums. +You can verify the integrity of the downloaded files using their PGP signatures or SHA-1 checksums. -## Verifying hashes +## Verifying Hashes -You can download MD5, SHA1 and SHA256 hashes using these links. Note that these links are for first-class Apache -Software Foundation mirrors so there will be reduced opportunity for tampering with these files. +To verify the downloads, first get the MD5, SHA1 and/or SHA256 hashes using these links. +Note that all links are for first-class Apache Software Foundation mirrors +so there is already reduced opportunity for anyone maliciously tampering with these files. <table class="table"> <tr> <th>Artifact</th> -<th colspan="2">MD5 hash</th> -<th colspan="2">SHA1 hash</th> -<th colspan="2">SHA256 hash</th> +<th colspan="3">Hashes</th> </tr> + +{% for v in site.brooklyn-stable-versions %} <tr> -<td>apache-brooklyn-0.7.0-M2-incubating.tar.gz</td> -<td><a href="https://www.us.apache.org/dist/incubator/brooklyn/0.7.0-M2-incubating/apache-brooklyn-0.7.0-M2-incubating.tar.gz.md5";>US</a></td> -<td><a href="https://www.eu.apache.org/dist/incubator/brooklyn/0.7.0-M2-incubating/apache-brooklyn-0.7.0-M2-incubating.tar.gz.md5";>EU</a></td> -<td><a href="https://www.us.apache.org/dist/incubator/brooklyn/0.7.0-M2-incubating/apache-brooklyn-0.7.0-M2-incubating.tar.gz.sha1";>US</a></td> -<td><a href="https://www.eu.apache.org/dist/incubator/brooklyn/0.7.0-M2-incubating/apache-brooklyn-0.7.0-M2-incubating.tar.gz.sha1";>EU</a></td> -<td><a href="https://www.us.apache.org/dist/incubator/brooklyn/0.7.0-M2-incubating/apache-brooklyn-0.7.0-M2-incubating.tar.gz.sha256";>US</a></td> -<td><a href="https://www.eu.apache.org/dist/incubator/brooklyn/0.7.0-M2-incubating/apache-brooklyn-0.7.0-M2-incubating.tar.gz.sha256";>EU</a></td> +<td>apache-brooklyn-{{ v }}.tar.gz</td> +<td><a href="https://www.apache.org/dist/incubator/brooklyn/{{ v }}/apache-brooklyn-{{ v }}.tar.gz.md5">md5</a></td> +<td><a href="https://www.apache.org/dist/incubator/brooklyn/{{ v }}/apache-brooklyn-{{ v }}.tar.gz.sha1">sha1</a></td> +<td><a href="https://www.apache.org/dist/incubator/brooklyn/{{ v }}/apache-brooklyn-{{ v }}.tar.gz.sha256">sha256</a></td> </tr> +{% endfor %} </table> You can verify the SHA1 or SHA256 hashes easily by placing the files in the same folder as the download artifact and then running `shasum`, which is included in most UNIX-like systems: {% highlight bash %} -shasum -c apache-brooklyn-{{ site.data.brooklyn.version }}.tar.gz.sha1 -shasum -c apache-brooklyn-{{ site.data.brooklyn.version }}.tar.gz.sha256 +shasum -c apache-brooklyn-{{ site.brooklyn-stable-version }}.tar.gz.sha1 +shasum -c apache-brooklyn-{{ site.brooklyn-stable-version }}.tar.gz.sha256 {% endhighlight %} You can verify the MD5 hashes by running a command like this, and comparing the output to the contents of the `.md5` file: {% highlight bash %} -md5 apache-brooklyn-{{ site.data.brooklyn.version }}.tar.gz +md5 apache-brooklyn-{{ site.brooklyn-stable-version }}.tar.gz {% endhighlight %} -### Verifying PGP signatures using PGP or GPG +### Verifying PGP Signatures using PGP or GPG You can download PGP/GPG signatures using these links. Note that these links are for first-class Apache Software Foundation mirrors so there will be reduced opportunity for tampering with these files. @@ -52,18 +51,20 @@ Software Foundation mirrors so there will be reduced opportunity for tampering w <table class="table"> <tr> <th>Artifact</th> -<th colspan="2">Mirror</th> +<th colspan="2">Link</th> </tr> <tr> -<td>Release Manager's public keys (KEYS)</td> -<td><a href="https://www.us.apache.org/dist/incubator/brooklyn/KEYS";>US</a></td> -<td><a href="https://www.eu.apache.org/dist/incubator/brooklyn/KEYS";>EU</a></td> +<td>Release Manager's public keys</td> +<td><a href="https://www.apache.org/dist/incubator/brooklyn/KEYS";>KEYS</a></td> </tr> + +{% for v in site.brooklyn-stable-versions %} <tr> -<td>apache-brooklyn-0.7.0-M2-incubating.tar.gz.asc</td> -<td><a href="https://www.us.apache.org/dist/incubator/brooklyn/0.7.0-M2-incubating/apache-brooklyn-0.7.0-M2-incubating.tar.gz.asc";>US</a></td> -<td><a href="https://www.eu.apache.org/dist/incubator/brooklyn/0.7.0-M2-incubating/apache-brooklyn-0.7.0-M2-incubating.tar.gz.asc";>EU</a></td> +<td>apache-brooklyn-{{ site.brooklyn-stable-version }}.tar.gz.asc</td> +<td><a href="https://www.apache.org/dist/incubator/brooklyn/{{ site.brooklyn-stable-version }}/apache-brooklyn-{{ site.brooklyn-stable-version }}.tar.gz.asc">asc</a></td> </tr> +{% endfor %} + </table> In order to validate the release signature, download both the release `.asc` file for the release, and the `KEYS` file @@ -71,15 +72,21 @@ which contains the public keys of key individuals in the Apache Brooklyn project Verify the signatures using one of the following commands: - pgpk -a KEYS - pgpv brooklyn-{{ site.brooklyn-version }}-dist.tar.gz.asc +{% highlight bash %} +pgpk -a KEYS +pgpv brooklyn-{{ site.brooklyn-stable-version }}-dist.tar.gz.asc +{% endhighlight %} or - pgp -ka KEYS - pgp brooklyn-{{ site.brooklyn-version }}-dist.zip.asc +{% highlight bash %} +pgp -ka KEYS +pgp brooklyn-{{ site.brooklyn-stable-version }}-dist.zip.asc +{% endhighlight %} or - gpg --import KEYS - gpg --verify brooklyn-{{ site.brooklyn-version }}-dist.tar.gz.asc +{% highlight bash %} +gpg --import KEYS +gpg --verify brooklyn-{{ site.brooklyn-stable-version }}-dist.tar.gz.asc +{% endhighlight %} http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/772ea293/docs/website/meta/versions.md ---------------------------------------------------------------------- diff --git a/docs/website/meta/versions.md b/docs/website/meta/versions.md index 47cc32a..b295040 100644 --- a/docs/website/meta/versions.md +++ b/docs/website/meta/versions.md @@ -18,10 +18,10 @@ This documentation was generated {{ site.time | date_to_string }}. Apache versions: -* **[0.7.0-SNAPSHOT](/v/0.7.0-SNAPSHOT/)**: bleeding-edge (not voted on or endorsed by Apache!) - * **[0.7.0-M2-incubating](/v/0.7.0-M2-incubating/)**: YAML, persistence, Chef, Windows, Docker. The first Apache release! (Dec 2014) +* **[0.7.0-SNAPSHOT](/v/0.7.0-SNAPSHOT/)**: bleeding-edge (not voted on or endorsed by Apache!) + 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.
