Return-Path: X-Original-To: apmail-brooklyn-commits-archive@minotaur.apache.org Delivered-To: apmail-brooklyn-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 9CC6617661 for ; Tue, 1 Sep 2015 15:16:52 +0000 (UTC) Received: (qmail 45399 invoked by uid 500); 1 Sep 2015 15:16:52 -0000 Delivered-To: apmail-brooklyn-commits-archive@brooklyn.apache.org Received: (qmail 45374 invoked by uid 500); 1 Sep 2015 15:16:52 -0000 Mailing-List: contact commits-help@brooklyn.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@brooklyn.incubator.apache.org Delivered-To: mailing list commits@brooklyn.incubator.apache.org Received: (qmail 45364 invoked by uid 99); 1 Sep 2015 15:16:52 -0000 Received: from Unknown (HELO spamd3-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 01 Sep 2015 15:16:52 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd3-us-west.apache.org (ASF Mail Server at spamd3-us-west.apache.org) with ESMTP id 0F6BD182355 for ; Tue, 1 Sep 2015 15:16:52 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd3-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: 0.795 X-Spam-Level: X-Spam-Status: No, score=0.795 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, RP_MATCHES_RCVD=-0.006, URIBL_BLOCKED=0.001] autolearn=disabled Received: from mx1-eu-west.apache.org ([10.40.0.8]) by localhost (spamd3-us-west.apache.org [10.40.0.10]) (amavisd-new, port 10024) with ESMTP id V8b9UNS4GKlH for ; Tue, 1 Sep 2015 15:16:36 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-eu-west.apache.org (ASF Mail Server at mx1-eu-west.apache.org) with SMTP id 2352B34A9F for ; Tue, 1 Sep 2015 15:16:27 +0000 (UTC) Received: (qmail 42363 invoked by uid 99); 1 Sep 2015 15:16:24 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 01 Sep 2015 15:16:24 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id B094FDFE5F; Tue, 1 Sep 2015 15:16:24 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: heneveld@apache.org To: commits@brooklyn.incubator.apache.org Date: Tue, 01 Sep 2015 15:16:41 -0000 Message-Id: In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [18/28] incubator-brooklyn git commit: fix download links and add reference to snapshots fix download links and add reference to snapshots Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/5ae28706 Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/5ae28706 Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/5ae28706 Branch: refs/heads/master Commit: 5ae287066726dad91eb4375dc294ec4a961dd2cc Parents: f17da16 Author: Alex Heneveld Authored: Tue Sep 1 13:09:42 2015 +0100 Committer: Alex Heneveld Committed: Tue Sep 1 13:09:42 2015 +0100 ---------------------------------------------------------------------- .../_extra/big_examples/before-begin.include.md | 2 +- docs/_includes/fields.md | 26 ++----- docs/_plugins/brooklyn_metadata.rb | 14 +--- docs/guide/misc/download.md | 71 ++++++++++---------- docs/website/documentation/index.md | 6 +- docs/website/index.md | 3 +- docs/website/meta/versions.md | 24 ++++++- 7 files changed, 69 insertions(+), 77 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/5ae28706/docs/_extra/big_examples/before-begin.include.md ---------------------------------------------------------------------- diff --git a/docs/_extra/big_examples/before-begin.include.md b/docs/_extra/big_examples/before-begin.include.md index e05f9f1..5170c64 100644 --- a/docs/_extra/big_examples/before-begin.include.md +++ b/docs/_extra/big_examples/before-begin.include.md @@ -11,7 +11,7 @@ To use the examples, you'll need ``curl``, ``git``, ``java`` (1.6+), and ``maven {% if SNAPSHOT %} First, grab a copy of the Brooklyn snapshot distribution you wish to use from -[the Sonatype snapshot repo]({{ sonatype_repo_groupid_url }}brooklyn-dist/) +[the maven repository]({{ this_dist_url_list }}) (or build it yourself following instructions [here]({{ site.path.guide }}/dev/build/)), unpack it to your favourite location (e.g. `$(pwd)`), and export `BROOKLYN_HOME`: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/5ae28706/docs/_includes/fields.md ---------------------------------------------------------------------- diff --git a/docs/_includes/fields.md b/docs/_includes/fields.md index 67dd032..d9e74b7 100644 --- a/docs/_includes/fields.md +++ b/docs/_includes/fields.md @@ -14,37 +14,19 @@ {% capture apache_snapshots_repo_groupid_url %}{{ this_repo_base_url }}/content/repositories/snapshots/{{ brooklyn_group_id_path }}{% endcapture %} {% capture apache_releases_repo_groupid_url %}{{ this_repo_base_url }}/content/repositories/releases/{{ brooklyn_group_id_path }}{% endcapture %} -{% capture this_repo_base_url_content %}{{ apache_snapshots_repo_groupid_url }}{% endcapture %} +{% capture this_repo_base_url_content %}{% if SNAPSHOT %}{{ apache_snapshots_repo_groupid_url }}{% else %}{{ apache_releases_repo_groupid_url }}{% endif %}{% endcapture %} {% capture this_dist_url_list %}{{ this_repo_base_url_content }}/brooklyn-dist/{{ site.brooklyn-version }}/{% endcapture %} -{% capture this_alljar_url_list %}{{ this_repo_base_url_content }}/brooklyn-all/{{ site.brooklyn-version }}/{% endcapture %} {% if SNAPSHOT %} - {% capture this_dist_url_zip %}{{ this_repo_base_url_artifact }}?r=snapshots&g={{ brooklyn_group_id }}&a=brooklyn-dist&v={{ site.brooklyn-version }}&e=zip&c=dist{% endcapture %} - {% capture this_dist_url_tgz %}{{ this_repo_base_url_artifact }}?r=snapshots&g={{ brooklyn_group_id }}&a=brooklyn-dist&v={{ site.brooklyn-version }}&e=tar.gz&c=dist{% endcapture %} - {% capture this_alljar_url_jar %}{{ this_repo_base_url_artifact }}?r=snapshots&g={{ brooklyn_group_id }}&a=brooklyn-all&v={{ site.brooklyn-version }}&e=jar&c=with-dependencies{% endcapture %} + + {% capture this_dist_url_zip %}{{ this_repo_base_url_artifact }}?r=snapshots&g={{ brooklyn_group_id }}&a=brooklyn-dist&v={{ site.brooklyn-version }}&c=dist&e=zip{% endcapture %} + {% capture this_dist_url_tgz %}{{ this_repo_base_url_artifact }}?r=snapshots&g={{ brooklyn_group_id }}&a=brooklyn-dist&v={{ site.brooklyn-version }}&c=dist&e=tar.gz{% endcapture %} {% else %} {% capture this_dist_url_zip %}{{ this_dist_url_list }}/brooklyn-dist-{{ site.brooklyn-version }}-dist.zip{% endcapture %} {% capture this_dist_url_tgz %}{{ this_dist_url_list }}/brooklyn-dist-{{ site.brooklyn-version }}-dist.tar.gz{% endcapture %} - {% capture this_alljar_url_jar %}{{ this_alljar_url_list }}/brooklyn-all-{{ site.brooklyn-version }}-with-dependencies.jar{% endcapture %} {% endif %} {% capture this_anything_url_search %}{{ this_repo_base_url_search }};gav~{{ brooklyn_group_id }}~~{{ site.brooklyn-version }}~~{% endcapture %} {% capture this_dist_url_search %}{{ this_repo_base_url_search }};gav~{{ brooklyn_group_id }}~brooklyn-dist~{{ site.brooklyn-version }}~~{% endcapture %} -{% capture this_alljar_url_search %}{{ this_repo_base_url_search }};gav~{{ brooklyn_group_id }}~brooklyn-all~{{ site.brooklyn-version }}~~{% endcapture %} - -{% capture brooklyn_examples_branch %}{% if SNAPSHOT %}{{ site.brooklyn-snapshot-git-branch }}{% else %}{{ site.brooklyn-version }}{% endif %}{% endcapture %} - -{% capture cloudsoft_snapshots_base_url %}http://developers.cloudsoftcorp.com/maven/snapshots/{% endcapture %} -{% capture cloudsoft_releases_base_url %}http://developers.cloudsoftcorp.com/maven/releases/{% endcapture %} -{% capture cloudsoft_this_version_base_url %}http://developers.cloudsoftcorp.com/maven/{% if SNAPSHOT %}snapshots/{% else %}releases/{% endif %}{% endcapture %} - -{% capture cloudsoft_this_version_groupid_url %}{{ cloudsoft_this_version_base_url }}io/brooklyn/{% endcapture %} -{% capture cloudsoft_this_dist_url_dir %}{{ cloudsoft_this_version_groupid_url }}brooklyn-dist/{{ site.brooklyn-version }}/{% endcapture %} -{% capture cloudsoft_this_alljar_url_dir %}{{ cloudsoft_this_version_groupid_url }}brooklyn-all/{{ site.brooklyn-version }}/{% endcapture %} - - -{% capture sonatype_repo_groupid_url %}https://oss.sonatype.org/content/groups/public/io/brooklyn/{% endcapture %} - -{% capture mavencentral_repo_groupid_url %}http://repo1.maven.org/maven2/io/brooklyn/{% endcapture %} http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/5ae28706/docs/_plugins/brooklyn_metadata.rb ---------------------------------------------------------------------- diff --git a/docs/_plugins/brooklyn_metadata.rb b/docs/_plugins/brooklyn_metadata.rb index 34d5dd0..d7913a1 100644 --- a/docs/_plugins/brooklyn_metadata.rb +++ b/docs/_plugins/brooklyn_metadata.rb @@ -21,16 +21,11 @@ module BrooklynMetadata "search" => { "all" => "https://oss.sonatype.org/index.html#nexus-search;gav~io.brooklyn~~#{ BrooklynMetadata::BROOKLYN_VERSION }~~", "dist" => "https://oss.sonatype.org/index.html#nexus-search;gav~io.brooklyn~brooklyn-dist~#{ BrooklynMetadata::BROOKLYN_VERSION }~~", - "alljar" => "https://oss.sonatype.org/index.html#nexus-search;gav~io.brooklyn~brooklyn-dist~#{ BrooklynMetadata::BROOKLYN_VERSION }~~" }, "dist" => { "base" => "https://oss.sonatype.org/content/groups/public/io/brooklyn/brooklyn-dist/#{ BrooklynMetadata::BROOKLYN_VERSION }/", "zip" => "https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=io.brooklyn&v=#{ BrooklynMetadata::BROOKLYN_VERSION }&a=brooklyn-dist&c=dist&e=zip", "tgz" => "https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=io.brooklyn&v=#{ BrooklynMetadata::BROOKLYN_VERSION }&a=brooklyn-dist&c=dist&e=tar.gz" - }, - "alljar" => { - "base" => "https://oss.sonatype.org/content/groups/public/io/brooklyn/brooklyn-all/#{ BrooklynMetadata::BROOKLYN_VERSION }/", - "jar" => "https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=io.brooklyn&v=#{ BrooklynMetadata::BROOKLYN_VERSION }}&a=brooklyn-all&c=with-dependencies&e=jar" } } @@ -40,16 +35,11 @@ module BrooklynMetadata "search" => { "all" => "http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22io.brooklyn%22%20AND%20v%3A%22#{ BrooklynMetadata::BROOKLYN_VERSION }%22", "dist" => "http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22io.brooklyn%22%20AND%20a%3A%22brooklyn-dist%22%20AND%20v%3A%22#{ BrooklynMetadata::BROOKLYN_VERSION }%22", - "alljar" => "http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22io.brooklyn%22%20AND%20a%3A%22brooklyn-all%22%20AND%20v%3A%22#{ BrooklynMetadata::BROOKLYN_VERSION }%22" }, "dist" => { "base" => "http://repo1.maven.org/maven2/io/brooklyn/brooklyn-dist/#{ BrooklynMetadata::BROOKLYN_VERSION }/", "zip" => "http://repo1.maven.org/maven2/io/brooklyn/brooklyn-dist/#{ BrooklynMetadata::BROOKLYN_VERSION }/brooklyn-dist-#{ BrooklynMetadata::BROOKLYN_VERSION }-dist.zip", "tgz" => "http://repo1.maven.org/maven2/io/brooklyn/brooklyn-dist/#{ BrooklynMetadata::BROOKLYN_VERSION }/brooklyn-dist-#{ BrooklynMetadata::BROOKLYN_VERSION }-dist.tar.gz" - }, - "alljar" => { - "base" => "http://repo1.maven.org/maven2/io/brooklyn/brooklyn-all/#{ BrooklynMetadata::BROOKLYN_VERSION }/", - "jar" => "http://repo1.maven.org/maven2/io/brooklyn/brooklyn-all/#{ BrooklynMetadata::BROOKLYN_VERSION }/brooklyn-all-#{ BrooklynMetadata::BROOKLYN_VERSION }-with-dependencies.jar" } } end @@ -59,7 +49,9 @@ module BrooklynMetadata site.config['brooklyn'] = { "version" => BrooklynMetadata::BROOKLYN_VERSION, "is_snapshot" => is_snapshot, - "url" => url_set + "is_release" => !is_snapshot, + "url" => url_set, + "git_branch" => git_branch } # config is preferred of data, because you can write just {{ site.brooklyn.xxx }}, http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/5ae28706/docs/guide/misc/download.md ---------------------------------------------------------------------- diff --git a/docs/guide/misc/download.md b/docs/guide/misc/download.md index c79ef16..fdec037 100644 --- a/docs/guide/misc/download.md +++ b/docs/guide/misc/download.md @@ -16,21 +16,20 @@ For more information, see the [main download page]({{ site.path.website }}/downl Download File/Format - checksums (?) + checksums (?) Distro brooklyn-dist-{{ site.brooklyn-version }}-dist.zip - PGP, SHA1 + + {% if site.brooklyn.is_release %}PGP, {% endif %} + SHA1 brooklyn-dist-{{ site.brooklyn-version }}-dist.tar.gz - PGP, SHA1 - - - All Jar - brooklyn-all-{{ site.brooklyn-version }}-with-dependencies.jar - PGP, SHA1 + + {% if site.brooklyn.is_release %}PGP, {% endif %} + SHA1 Apache Repo @@ -51,41 +50,25 @@ For more information, see the [main download page]({{ site.path.website }}/downl -## The Distro +## The Dist -The distribution archive contains Brooklyn as a standalone executable package. +The binary distribution archive contains Brooklyn as a standalone executable package. * [This version ZIP]({{ this_dist_url_zip }}) * [This version TGZ]({{ this_dist_url_tgz }}) * [Apache stable versions]({{ apache_releases_repo_groupid_url }}/brooklyn-dist/) * [Apache snapshot versions]({{ apache_snapshots_repo_groupid_url }}/brooklyn-dist/) -Very old versions are available at [Maven Central]({{ mavencentral_repo_groupid_url }}brooklyn-dist/) for stable releases -and [Sonatype]({{ sonatype_repo_groupid_url }}brooklyn-dist/) for snapshot versions. +Released versions are also available at +[Maven Central](https://search.maven.org/#search%7Cga%7C1%7Corg.apache.brooklyn). {% if site.brooklyn-version contains 'SNAPSHOT' %} **Please note**: You are reading the documentation for a snapshot version of Brooklyn. -You should always confirm that the source and date for snapshot artifacts. +You should always confirm that the source repository and datestamp for downloaded snapshot artifacts +match the intended dependencies, as snapshot artifacts change as code is written. {% endif %} - - -## The All Jar - -This is a single JAR containing all of Brooklyn and its dependencies, for developing Brooklyn into your own applications. If not using maven, just add it to your classpath. - -* [This version]({{ this_alljar_url_jar }}) -* [All Apache stable versions]({{ apache_releases_repo_groupid_url }}/brooklyn-all/) -* [All Apache snapshot versions]({{ apache_snapshots_repo_groupid_url }}/brooklyn-all/) - -Very old versions are available at [Maven Central]({{ mavencentral_repo_groupid_url }}brooklyn-all/) for stable releases -and [Sonatype]({{ sonatype_repo_groupid_url }}brooklyn-all/) for snapshot versions. - -{% if site.brooklyn-version contains 'SNAPSHOT' %} -**Again**, check the source and date for SNAPSHOT JARs. -{% endif %} - ## Release Notes Release notes can be found [here]({{ site.path.guide }}/misc/release-notes.html). @@ -122,7 +105,7 @@ If you use Maven, you can add Brooklyn with the following in your pom: {% endhighlight %} -`brooklyn-all` (used above) brings in all dependencies, including jclouds. +`brooklyn-all` brings in all dependencies, including jclouds. If you prefer a smaller repo you might want just ``brooklyn-core``, ``brooklyn-policies``, and some of ``brooklyn-software-webapp``, ``brooklyn-software-database``, ``brooklyn-software-messaging``, or others (browse the full list [here]({{ this_anything_url_search }})). @@ -157,8 +140,8 @@ you can add some of the following sections: {% endhighlight %} {% if SNAPSHOT %} -**Please note**: to use a snapshot version of Brooklyn, you must either have Brooklyn built locally -or one of the additional snapshot repositories above. +**Please note**: to add a snapshot version of Brooklyn as a dependency to your project, +you must either have Brooklyn built locally or one of these snapshot repositories in your POM. {% endif %} @@ -166,11 +149,27 @@ or one of the additional snapshot repositories above. ## Source Code -Full source is at [github.com/apache/incubator-brooklyn](http://github.com/apache/incubator-brooklyn). +Source code is hosted at [github.com/apache/incubator-brooklyn](http://github.com/apache/incubator-brooklyn), +with this version in branch [{{ site.brooklyn.git_branch }}]({{ site.brooklyn.url.git }}). Information on working with the source is [here]({{ site.path.guide }}/dev/code). -Alternatively you can download archives of the source directly: +You can download archives of the source directly: + + + + + +{% if site.brooklyn.git_branch != 'master' %} + + + + +{% endif %} +
{{ site.brooklyn.git_branch }}
 + + +
master
 - +
\ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/5ae28706/docs/website/documentation/index.md ---------------------------------------------------------------------- diff --git a/docs/website/documentation/index.md b/docs/website/documentation/index.md index 073a7ba..df22fd7 100644 --- a/docs/website/documentation/index.md +++ b/docs/website/documentation/index.md @@ -4,14 +4,14 @@ title: Documentation children: - /guide/ - /guide/dev/ +- ../meta/versions.md - other-docs.md --- {% comment %} -TODO This is redundant with versions page. Link to versions page? List more things including other docs? -Basically make this page pretty... +TODO is this page used? -TODO also add FAQ +TODO add FAQ {% endcomment %} ## Official User Guide http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/5ae28706/docs/website/index.md ---------------------------------------------------------------------- diff --git a/docs/website/index.md b/docs/website/index.md index a23cac9..f3843d6 100644 --- a/docs/website/index.md +++ b/docs/website/index.md @@ -15,8 +15,9 @@ children: - { path: /guide/ops/index.md, title_in_menu: Operations, menu_customization: { dropdown_section_header: true } } - { path: /guide/dev/index.md, title_in_menu: Developer Guide } - - { path: documentation/other-docs.md, title_in_menu: Other Resources, + - { path: meta/versions.md, title_in_menu: Versions, menu_customization: { dropdown_new_section: true } } + - { path: documentation/other-docs.md, title_in_menu: Other Resources } - community/ - developers/ --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/5ae28706/docs/website/meta/versions.md ---------------------------------------------------------------------- diff --git a/docs/website/meta/versions.md b/docs/website/meta/versions.md index 6370e10..e178770 100644 --- a/docs/website/meta/versions.md +++ b/docs/website/meta/versions.md @@ -29,13 +29,31 @@ Apache Brooklyn has made the following releases: * [User guide](/v/0.7.0-M2-incubating/), download via mirrors «src.tar.gz» -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 + +Note: These "Version History" links are to permanent versions in the archive, +different to the "Current Version" links. +To prevent accidentally referring to out-of-date information, +a banner is displayed when accessing content from these. +If you wish you can disable all warnings or re-enable all warnings. +## Snapshot Versions + +Current work on Apache Brooklyn is done with SNAPSHOT version labels, +in the `master` branch or in a branch with the version label. +This code has not been voted on and are not endorsed by The Apache Software Foundation. +Documentation for these versions are uploaded from time to time, +and are provided here for reference: + +* **[0.8.0-SNAPSHOT](/v/0.8.0-SNAPSHOT/)**: latest unreleased version +(although docs may not be up-to-date with the latest code) + +* **[0.7.0-SNAPSHOT](/v/0.7.0-SNAPSHOT/)**: any changes since 0.7.0-incubating which would go into 0.7.1 +(mainly things from 0.8.0-SNAPSHOT which warranted being backported) + + ## Ancient Versions The versions below were made prior to joining The Apache Software Foundation, therefore **they are not endorsed by