tweaking community content using initial caps, fixing external links, removing "migrate" guide, using sections for auto-scroll in "How to Contribute"
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/893f7600 Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/893f7600 Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/893f7600 Branch: refs/heads/master Commit: 893f7600ca3bf33a4c6438f8a670e5198ade209d Parents: 4a5c34f Author: Alex Heneveld <[email protected]> Authored: Tue Jan 13 16:07:41 2015 +0000 Committer: Alex Heneveld <[email protected]> Committed: Tue Jan 13 16:07:41 2015 +0000 ---------------------------------------------------------------------- docs/_includes/sidemenu.html | 3 ++- docs/website/community/index.md | 2 +- docs/website/community/mailing-lists.md | 2 +- docs/website/developers/committers/index.md | 3 +++ .../committers/merging-contributed-code.md | 2 +- docs/website/developers/how-to-contribute.md | 24 +++++++++++--------- docs/website/developers/index.md | 5 ++-- docs/website/developers/migrate-to-apache.md | 4 ++++ 8 files changed, 28 insertions(+), 17 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/893f7600/docs/_includes/sidemenu.html ---------------------------------------------------------------------- diff --git a/docs/_includes/sidemenu.html b/docs/_includes/sidemenu.html index d231970..840cf50 100644 --- a/docs/_includes/sidemenu.html +++ b/docs/_includes/sidemenu.html @@ -47,7 +47,8 @@ </div> {% else %} {% comment %} case 3a side menu item {% endcomment %} - <a href="{{item.url}}" class="list-group-item{% if page.breadcrumb_paths contains item.menu_path %}{% unless item.menu_customization.force_inactive %} active{% endunless %}{% endif %}">{{ item.title_in_menu }}</a> + <a href="{{item.url}}" class="list-group-item{% if page.breadcrumb_paths contains item.menu_path %}{% unless item.menu_customization.force_inactive %} active{% endunless %}{% endif %}">{{ item.title_in_menu }} + {% if item.external %} <span class="octicon octicon-link-external"></span>{% endif %}</a> {% endif %} {% endfor %} http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/893f7600/docs/website/community/index.md ---------------------------------------------------------------------- diff --git a/docs/website/community/index.md b/docs/website/community/index.md index cda1526..6ba4000 100644 --- a/docs/website/community/index.md +++ b/docs/website/community/index.md @@ -4,7 +4,7 @@ title: Community children: - mailing-lists.md - irc.md -- { link: 'https://issues.apache.org/jira/browse/BROOKLYN', title: 'Bug tracker (JIRA)' } +- { link: 'https://issues.apache.org/jira/browse/BROOKLYN', title: 'Bug Tracker (JIRA)' } - { path: how-to-contribute-docs.md } --- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/893f7600/docs/website/community/mailing-lists.md ---------------------------------------------------------------------- diff --git a/docs/website/community/mailing-lists.md b/docs/website/community/mailing-lists.md index d38ec22..40cb72b 100644 --- a/docs/website/community/mailing-lists.md +++ b/docs/website/community/mailing-lists.md @@ -1,6 +1,6 @@ --- layout: website-normal -title: Mailing lists +title: Mailing Lists --- Our main discussion list is our *dev* list - here you can ask questions and get http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/893f7600/docs/website/developers/committers/index.md ---------------------------------------------------------------------- diff --git a/docs/website/developers/committers/index.md b/docs/website/developers/committers/index.md index 16b3cd5..e334762 100644 --- a/docs/website/developers/committers/index.md +++ b/docs/website/developers/committers/index.md @@ -3,6 +3,9 @@ layout: website-normal title: Committer's Guides children: - merging-contributed-code.md +- ../migrate-to-apache.md --- These pages contain information that is relevant to people with "committer" status in our project. + +{% include list-children.html %} http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/893f7600/docs/website/developers/committers/merging-contributed-code.md ---------------------------------------------------------------------- diff --git a/docs/website/developers/committers/merging-contributed-code.md b/docs/website/developers/committers/merging-contributed-code.md index 23dd2a0..02cbd07 100644 --- a/docs/website/developers/committers/merging-contributed-code.md +++ b/docs/website/developers/committers/merging-contributed-code.md @@ -1,6 +1,6 @@ --- layout: website-normal -title: Merging contributed code +title: Merging Contributed Code --- The Apache Brooklyn Git repositories are hosted in the ASF infrastructure and mirrored to Github. This is the current http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/893f7600/docs/website/developers/how-to-contribute.md ---------------------------------------------------------------------- diff --git a/docs/website/developers/how-to-contribute.md b/docs/website/developers/how-to-contribute.md index 0f2ce1e..ce8e2de 100644 --- a/docs/website/developers/how-to-contribute.md +++ b/docs/website/developers/how-to-contribute.md @@ -1,14 +1,18 @@ --- layout: website-normal title: How to Contribute +children: +- { section: CLA } +- { section: Jira } +- { section: GitHub } +- { section: Reviews } --- Welcome and thank you for your interest in contributing to Apache Brooklyn! This guide will take you through the process of making contributions to the Apache Brooklyn code base. -Contributor license agreement ------------------------------ +## <a id="CLA"></a> Contributor License Agreement Apache Brooklyn is licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). All contributions will be under this license, so please read and understand this license before contributing. @@ -18,23 +22,22 @@ Software Foundation. Please read the [guide to CLAs](https://www.apache.org/lice CLA with the Foundation. -Before you start ----------------- +## Before You Start -### Join the community +### Join the Community If it's your first contribution or it's a particularly big or complex contribution, things typically go much more smoothly when they start off with a conversation. Visit our [Community](index.html) page to see how you can contact us via IRC or email. -### Create an issue in Jira +### <a id="Jira"></a> Create an Issue in Jira Your first step is to create or find an issue in [Brooklyn's Jira](https://issues.apache.org/jira/browse/BROOKLYN) for your feature request or fix. For small changes this isn't necessary, but it's good to see if your change fixes an existing issue anyway. -### Contributing using GitHub +### <a id="GitHub"> Contributing using GitHub This is our preferred way for contributing code. Our GitHub repository is located at [https://github.com/apache/incubator-brooklyn](https://github.com/apache/incubator-brooklyn) @@ -56,11 +59,11 @@ as possible, and we will ask you to rebase again if master has moved before acce Finally, add a comment in the Jira issue with a link to the pull request so we know the code is ready to be reviewed. -### Reviews +### <a id="Reviews"></a> Reviews The Apache Brooklyn community will review your pull request before it is merged. This process can take a while, so please be patient. If we are slow to respond, please feel free to post a reminder to the PR, Jira issue, IRC channel -or mailing list - see the [Community](index.html) page to see how to contact us. +or mailing list - see the [Community](../community/) page to see how to contact us. During the review process you may be asked to make some changes to your submission. While working through feedback, it can be beneficial to create new commits so the incremental change is obvious. This can also lead to a complex set @@ -84,7 +87,6 @@ When producing patches, please use `git format-patch` or a similar mechanism - t attributed as the author of the patch when a committer merges it. -Handy Places ------------- +## Handy Places Development bookmarks are available [here](links.html). http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/893f7600/docs/website/developers/index.md ---------------------------------------------------------------------- diff --git a/docs/website/developers/index.md b/docs/website/developers/index.md index 41042cf..0f1180c 100644 --- a/docs/website/developers/index.md +++ b/docs/website/developers/index.md @@ -3,9 +3,10 @@ layout: website-normal title: Developers children: - how-to-contribute.md -- migrate-to-apache.md -- { link: 'https://issues.apache.org/jira/browse/BROOKLYN', title: 'Bug tracker (JIRA)' } +- /guide/dev/ - committers/ +- { link: 'http://github.com/apache/incubator-brooklyn', title: 'GitHub' } +- { link: 'https://issues.apache.org/jira/browse/BROOKLYN', title: 'Bug Tracker (JIRA)' } --- Hello developers! These pages are aimed at people who want to get involved with reading, changing, testing and otherwise http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/893f7600/docs/website/developers/migrate-to-apache.md ---------------------------------------------------------------------- diff --git a/docs/website/developers/migrate-to-apache.md b/docs/website/developers/migrate-to-apache.md index ece385d..79e5530 100644 --- a/docs/website/developers/migrate-to-apache.md +++ b/docs/website/developers/migrate-to-apache.md @@ -3,6 +3,10 @@ layout: website-normal title: How to Migrate --- +*This is old. Everyone has probably already migrated. +But just in case you need it, this page is being left a bit longer +(just taken out of the menus).* + Prior to our adoption by the Apache Incubator, Brooklyn was developed in a GitHub repository at `https://github.com/brooklyncentral/brooklyn`. If you already have a fork of this repository, follow this guide to smoothly shift
