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 2016/02/02 01:43:08 UTC
[1/2] brooklyn-docs git commit: update many docs to point at new
locations and have better instructions
Repository: brooklyn-docs
Updated Branches:
refs/heads/master f1da1755a -> 4e4aed4b5
update many docs to point at new locations and have better instructions
these docs are also pushed to be live at the /v/0.9.0-SNAPSHOT/ endpoint
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/b0458432
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/b0458432
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/b0458432
Branch: refs/heads/master
Commit: b0458432465bd40991d605585b570f8e03ff2d00
Parents: f1da175
Author: Alex Heneveld <al...@cloudsoftcorp.com>
Authored: Tue Feb 2 00:39:49 2016 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
Committed: Tue Feb 2 00:39:49 2016 +0000
----------------------------------------------------------------------
README.md | 20 +++---
_build/build.sh | 6 +-
_build/htmlproof-brooklyn.sh | 1 -
_build/serve-public-site.sh | 2 +-
_includes/base-head.html | 6 +-
_includes/footer.html | 2 +-
_includes/topmenu.html | 4 +-
_layouts/website-landing.html | 2 +-
guide/dev/code/submodules.md | 69 +++++++++++++-------
website/community/how-to-contribute-docs.md | 3 +-
.../committers/merging-contributed-code.md | 48 ++++++--------
website/developers/how-to-contribute.md | 14 ++--
website/developers/links.md | 6 +-
13 files changed, 100 insertions(+), 83 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/b0458432/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 0ca223f..9f2465b 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,7 @@ familiarise yourself with the standard workflow for Apache Brooklyn:
Workstation Setup
-----------------
-First, if you have not already done so, clone the `incubator-brooklyn` repository
+First, if you have not already done so, clone the `brooklyn` repository and subprojects
and set up the remotes as described in [Guide for committers][COMMIT].
The Brooklyn documentation uses Markdown notation (what this file is written in)
@@ -135,8 +135,8 @@ The site itself is hosted at `brooklyn.apache.org` with a `CNAME`
record from `brooklyn.io`.
Content is published to the site by updating an
-Apache subversion repository, `incubator-brooklyn-site-public` at
-`https://svn.apache.org/repos/asf/incubator/brooklyn/site`.
+Apache subversion repository, `brooklyn-site-public` at
+`https://svn.apache.org/repos/asf/brooklyn/site`.
See below for more information.
@@ -197,17 +197,17 @@ the generated HTML files must be checked in to Subversion, whereupon an automate
will publish the files to the live website.
So, to push changes the live site, you will need to have the website directory checked out
from the Apache subversion repository. We recommend setting this up as a sibling to your
-`incubator-brooklyn` git project directory:
+`brooklyn` git project directory:
# verify we're in the right location and the site does not already exist
ls _build/build.sh || { echo "ERROR: you should be in the docs/ directory to run this command" ; exit 1 ; }
- ls ../../incubator-brooklyn-site-public > /dev/null && { echo "ERROR: incubator-brooklyn-site-public dir already exists" ; exit 1 ; }
+ ls ../../brooklyn-site-public > /dev/null && { echo "ERROR: brooklyn-site-public dir already exists" ; exit 1 ; }
pushd `pwd -P`/../..
- svn --non-interactive --trust-server-cert co https://svn.apache.org/repos/asf/incubator/brooklyn/site incubator-brooklyn-site-public
+ svn --non-interactive --trust-server-cert co https://svn.apache.org/repos/asf/brooklyn/site brooklyn-site-public
# verify it
- cd incubator-brooklyn-site-public
+ cd brooklyn-site-public
ls style/img/apache-brooklyn-logo-244px-wide.png || { echo "ERROR: checkout is wrong" ; exit 1 ; }
export BROOKLYN_SITE_DIR=`pwd`
popd
@@ -219,10 +219,10 @@ structure, set BROOKLYN_SITE_DIR to point to the directory as above. Alternativ
using the instructions in `build.sh` as a guide.)
A typical update consists of the following commands (or a subset),
-copied to `${BROOKLYN_SITE_DIR-../../incubator-brooklyn-site-public}`:
+copied to `${BROOKLYN_SITE_DIR-../../brooklyn-site-public}`:
# ensure svn repo is up-to-date (very painful otherwise)
- cd ${BROOKLYN_SITE_DIR-../../incubator-brooklyn-site-public}
+ cd ${BROOKLYN_SITE_DIR-../../brooklyn-site-public}
svn up
cd -
@@ -248,7 +248,7 @@ Note in particular that deleted files need special attention (there is no analog
`git add -A`!). Look at deletions carefully, to try to avoid breaking links, but once
you've done that these commands might be useful:
- cd ${BROOKLYN_SITE_DIR-../../incubator-brooklyn-site-public}
+ cd ${BROOKLYN_SITE_DIR-../../brooklyn-site-public}
svn add * --force
export DELETIONS=$( svn status | sed -e '/^!/!d' -e 's/^!//' )
if [ ! -z "${DELETIONS}" ] ; then svn rm ${DELETIONS} ; fi
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/b0458432/_build/build.sh
----------------------------------------------------------------------
diff --git a/_build/build.sh b/_build/build.sh
index e5d196d..c892287 100755
--- a/_build/build.sh
+++ b/_build/build.sh
@@ -31,7 +31,7 @@ function help() {
echo "* --skip-javadoc : to skip javadoc build"
echo "* --quick-javadoc : to do a quick javadoc build (for testing)"
echo "* --serve : serve files from _site after building (for testing)"
- echo "* --install : install files from _site to the appropriate place in "'$'"BROOKLYN_SITE_DIR (or ../../incubator-brooklyn-site-public)"
+ echo "* --install : install files from _site to the appropriate place in "'$'"BROOKLYN_SITE_DIR (or ../../brooklyn-site-public)"
echo "* --skip-htmlproof : skip the HTML Proof run on _site"
echo "* --quick-htmlproof : do a fast HTML Proof run on _site (not checking external links)"
echo ""
@@ -244,8 +244,8 @@ function make_install() {
fi
if [ ! -z ${QUICK_JAVADOC+SET} ]; then echo "ERROR: --install not permitted when doing quick javadoc" ; return 1 ; fi
- SITE_DIR=${BROOKLYN_SITE_DIR-../../incubator-brooklyn-site-public}
- ls $SITE_DIR/style/img/apache-brooklyn-logo-244px-wide.png > /dev/null || { echo "ERROR: cannot find incubator-brooklyn-site-public; set BROOKLYN_SITE_DIR" ; return 1 ; }
+ SITE_DIR=${BROOKLYN_SITE_DIR-../../brooklyn-site-public}
+ ls $SITE_DIR/style/img/apache-brooklyn-logo-244px-wide.png > /dev/null || { echo "ERROR: cannot find brooklyn-site-public; set BROOKLYN_SITE_DIR" ; return 1 ; }
if [ -z ${INSTALL_RSYNC_OPTIONS+SET} ]; then echo "ERROR: --install not supported for this build" ; return 1 ; fi
if [ -z ${INSTALL_RSYNC_SUBDIR+SET} ]; then echo "ERROR: --install not supported for this build" ; return 1 ; fi
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/b0458432/_build/htmlproof-brooklyn.sh
----------------------------------------------------------------------
diff --git a/_build/htmlproof-brooklyn.sh b/_build/htmlproof-brooklyn.sh
index 5fa6b1b..cb36c71 100755
--- a/_build/htmlproof-brooklyn.sh
+++ b/_build/htmlproof-brooklyn.sh
@@ -7,7 +7,6 @@ require 'html/proofer'
HTML::Proofer.new("./_site", {
:href_ignore => [
/https?:\/\/127.*/,
- /https?:\/\/github.com\/apache\/incubator-brooklyn\/edit.*/,
((ARGV.include? "--ignore-v-refs") ? /.*\/v\/.*/ : /ignore/),
((ARGV.include? "--v-only") ? /\/(|[^v].*|.[^\/].*)/ : /ignore/)
],
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/b0458432/_build/serve-public-site.sh
----------------------------------------------------------------------
diff --git a/_build/serve-public-site.sh b/_build/serve-public-site.sh
index 70c6470..6f7661d 100755
--- a/_build/serve-public-site.sh
+++ b/_build/serve-public-site.sh
@@ -1 +1 @@
-ruby -run -e httpd ${BROOKLYN_SITE_DIR-../../incubator-brooklyn-site-public} -p 4000
+ruby -run -e httpd ${BROOKLYN_SITE_DIR-../../brooklyn-site-public} -p 4000
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/b0458432/_includes/base-head.html
----------------------------------------------------------------------
diff --git a/_includes/base-head.html b/_includes/base-head.html
index 0773dc2..3f79d02 100644
--- a/_includes/base-head.html
+++ b/_includes/base-head.html
@@ -14,9 +14,9 @@
<link href="{{site.path.style}}/css/website.css" rel="stylesheet">
<script src="{% dependency_url jquery.js %}"></script>
-<script src="{% dependency_url glossarizer.js %}"></script>
+<script src="{{ site.path.style }}/deps/glossarizer.js"></script>
<script src="{% dependency_url bootstrap.js %}"></script>
-<script src="{% dependency_url tooltip.js %}"></script>
+<script src="{{ site.path.style }}/deps/tooltip.js"></script>
<script type="text/javascript" src="{{ site.path.style }}/deps/jquery.cookie.js"></script>
<script>
$(function(){
@@ -27,4 +27,4 @@ $(function(){
callback: function(){ new tooltip(); }
});
});
-</script>
\ No newline at end of file
+</script>
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/b0458432/_includes/footer.html
----------------------------------------------------------------------
diff --git a/_includes/footer.html b/_includes/footer.html
index 316fe5a..2531d46 100644
--- a/_includes/footer.html
+++ b/_includes/footer.html
@@ -5,7 +5,7 @@
Apache Brooklyn is distributed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License v2.0</a>.
</div>
<div class="col-md-2">
- <a class="btn btn-sm btn-default" href="https://github.com/apache/incubator-brooklyn/edit/master/docs/{{ page.path }}">Edit This Page</a>
+ <a class="btn btn-sm btn-default" href="https://github.com/apache/brooklyn-docs/edit/master/{{ page.path }}">Edit This Page</a>
<a href="{{ site.url_root }}{{ site.path.website }}/community/how-to-contribute-docs.html"
data-toggle="tooltip" data-placement="top" title="How to Edit Documentation" data-delay="400"/>
<span class="octicon octicon-question octicon-footer"></span>
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/b0458432/_includes/topmenu.html
----------------------------------------------------------------------
diff --git a/_includes/topmenu.html b/_includes/topmenu.html
index 0275794..290c8ee 100644
--- a/_includes/topmenu.html
+++ b/_includes/topmenu.html
@@ -59,8 +59,8 @@
<div class="container-sidebar-right">
<div class="navbar-sidebar-right-icons">
- <a href="https://github.com/apache/incubator-brooklyn" class="navbar-icon navbar-icon-shift icon-github"
- data-toggle="tooltip" data-placement="bottom" title="GitHub: apache/incubator-brooklyn"/>
+ <a href="https://github.com/apache/brooklyn" class="navbar-icon navbar-icon-shift icon-github"
+ data-toggle="tooltip" data-placement="bottom" title="GitHub: apache/brooklyn"/>
<a href="https://twitter.com/#!/search?q=brooklyncentral" class="navbar-icon navbar-icon-shift icon-twitter"
data-toggle="tooltip" data-placement="bottom" title="Twitter: @brooklyncentral"/>
<a href="http://webchat.freenode.net/?channels=brooklyncentral" class="navbar-icon icon-irc"
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/b0458432/_layouts/website-landing.html
----------------------------------------------------------------------
diff --git a/_layouts/website-landing.html b/_layouts/website-landing.html
index 7d2a6e4..da76664 100644
--- a/_layouts/website-landing.html
+++ b/_layouts/website-landing.html
@@ -31,7 +31,7 @@ layout: website-base
</div>
<div class="col-md-3">
<p>
- <a class="btn btn-sm btn-default" href="https://github.com/apache/incubator-brooklyn/edit/master/docs/{{ page.path }}">Edit This Page</a>
+ <a class="btn btn-sm btn-default" href="https://github.com/apache/brooklyn-docs/edit/master/{{ page.path }}">Edit This Page</a>
<a href="{{ site.url_root }}{{ site.path.website }}/community/how-to-contribute-docs.html"
data-toggle="tooltip" data-placement="top" title="How to Edit Documentation" data-delay="400"/>
<span class="octicon octicon-question octicon-footer"></span>
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/b0458432/guide/dev/code/submodules.md
----------------------------------------------------------------------
diff --git a/guide/dev/code/submodules.md b/guide/dev/code/submodules.md
index 06380c2..ea7c3a1 100644
--- a/guide/dev/code/submodules.md
+++ b/guide/dev/code/submodules.md
@@ -5,31 +5,55 @@ layout: website-normal
## Setting Up Forks
-If you're contributing regularly, you'll want your submodules to pull from the `apache` repo
+If you're contributing regularly, you'll want your submodules to pull from the repo in the Apache GitHub org
and push to your fork.
-You'll need to create a fork and the set up your local submodules should then have:
+You'll need to create a fork and then set up your local submodules should then have:
* your fork as the `origin` remote repo
-* the Apache github repo as the `upstream` remote repo
-* optionally the repo at the Apache git server as the `apache` remote repo
+* the Apache GitHub repo as the `upstream` remote repo,
+ optionally with `origin` set as the `push` target (since you can't push to `github.com/apache`)
+ and fetch set up to get pull-request branches
+* optionally the repo at the Apache git server as the `apache-git` remote repo
-This can be done automatically with the following commands:
+Assuming you've checked out from the Apache GitHub repos
+following [the standard instructions](index.html)
+(such that that repo is the `origin` remote and you don't have any forks in your GitHub account --
+if you do you should probably delete them as their upstream is likely to be wrong!),
+then you can use the following script to automatically do the fork at GitHub and modify your locally-defined remote repos:
{% highlight bash %}
- hub fork
- git remote add apache https://git-wip-us.apache.org/repos/asf/$x
- for x in brooklyn-* ; do
- pushd $x
- hub fork
- git remote add apache https://git-wip-us.apache.org/repos/asf/$x
- popd
- done
+hub fork
+# the above triggers a fork at GitHub and then does a git remote rename of origin to upstream
+# and a git add origin pointing to your fork
+
+# configure upstream so pushes go to origin
+git remote set-url --push upstream $(git remote -v | grep origin | grep push | awk '{print $2}')
+# and configure master branch to pull/push against "upstream", i.e. pull from apache/ and push to your repo
+git checkout master && git branch --set-upstream-to upstream/master
+
+# configure git to fetch pull-request branches
+git config --local --add remote.upstream.fetch '+refs/pull/*/head:refs/remotes/upstream/pr/*'
+
+# configure the apache-git remote as the canonical Apache git server (not GitHub)
+git remote add apache-git https://git-wip-us.apache.org/repos/asf/brooklyn
+
+for x in brooklyn-* ; do
+ # repeat the above for each subproject
+ pushd $x
+ hub fork
+ git remote set-url --push upstream $(git remote -v | grep origin | grep push | awk '{print $2}')
+ git checkout master && git branch --set-upstream-to upstream/master
+ git config --local --add remote.upstream.fetch '+refs/pull/*/head:refs/remotes/upstream/pr/*'
+ git remote add apache-git https://git-wip-us.apache.org/repos/asf/$x
+ popd
+done
{% endhighlight %}
This requires the command-line tool `hub` [from github](https://github.com/github/hub) (or `sudo npm install -g hub`),
run in the directory of the uber-project checked out earlier.
-You can then pull and update from upstream, push to origin, and create pull requests in each sub-project.
+You should then be able pull and update from upstream, push to origin, and create pull requests in each sub-project.
+
Cross-project changes will require multiple PRs:
try to minimise these, especially where one depends on another,
and especially especially where two depend on each other -- that is normally a sign of broken backwards compatibility!
@@ -37,6 +61,8 @@ Open the PRs in dependency order and assist reviewers by including the URLs of a
in the dependent PR to help reviewers
(dependency PRs will then include a "mention" comment of the dependent PR).
+For information on reviewing and committing PRs, see [the committer's guide]({{site.path.website}}/developers/committers/merging-contributed-code.html).
+
## Things You Should Know
@@ -121,15 +147,14 @@ for x in brooklyn-* ; do pushd $x ; git status ; popd ; done
If you need to apply code changes made pre-graduation, against the incubator repository,
splitting it up into submodules, it's fairly straightforward:
-1. In the incubator codebase, start at its final state, in `master`.
-2. `git checkout -b making-a-diff`
-3. Merge or rebase the required commits.
- Ensure conflicts are resolved, but don't worry about commit messages.
-4. `git diff > /tmp/diff`
+1. In the incubator codebase, start at its final state: `cd .../incubator-brooklyn && git checkout master && git pull`
+2. Make a branch for your merged changes: `git checkout -b my-branch-merged-master`
+3. Merge or rebase the required commits (resolving conflicts; but don't worry about commit messages): `git merge my-branch`
+4. Create a patch file: `git diff > /tmp/diff-for-my-branch`
5. Go to the new `brooklyn` uber-project directory.
- Ensure you are at master and all subprojects updated (`git sup`).
-6. `patch -p1 < /tmp/diff`
-7. Run `git ss` to inspect the changes.
+ Ensure you are at master and all subprojects updated: `cd .../brooklyn/ && git sup`
+6. Apply the patch: `patch -p1 < /tmp/diff-for-my-branch`
+7. Inspect the changes: `git ss`
8. Test it, commit each changed project on a branch and create pull requests.
Where applicable, record the original author(s) and message(s) in the commit.
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/b0458432/website/community/how-to-contribute-docs.md
----------------------------------------------------------------------
diff --git a/website/community/how-to-contribute-docs.md b/website/community/how-to-contribute-docs.md
index 2873c3a..84fd47b 100644
--- a/website/community/how-to-contribute-docs.md
+++ b/website/community/how-to-contribute-docs.md
@@ -62,4 +62,5 @@ For More Information
Advanced instructions for building, previewing and publishing docs are in a `README.md` file
in the `docs` folder; see those instructions
-[here](https://github.com/apache/incubator-brooklyn/tree/master/docs/README.md).
+[here](https://github.com/apache/brooklyn-docs).
+
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/b0458432/website/developers/committers/merging-contributed-code.md
----------------------------------------------------------------------
diff --git a/website/developers/committers/merging-contributed-code.md b/website/developers/committers/merging-contributed-code.md
index 02cbd07..e910e96 100644
--- a/website/developers/committers/merging-contributed-code.md
+++ b/website/developers/committers/merging-contributed-code.md
@@ -6,8 +6,8 @@ title: Merging Contributed Code
The Apache Brooklyn Git repositories are hosted in the ASF infrastructure and mirrored to Github. This is the current
repository layout:
-- [Apache](https://git-wip-us.apache.org/repos/asf?s=incubator-brooklyn) - the main and official repository
-- [GitHub](https://github.com/apache/incubator-brooklyn) - mirror of the ASF repository, used to accept contributions
+- [Apache](https://git-wip-us.apache.org/repos/asf?s=brooklyn) - the main and official repository
+- [GitHub](https://github.com/apache/brooklyn) - mirror of the ASF repository, used to accept contributions
and do code reviews
@@ -36,24 +36,14 @@ Rules of thumb
Setting up your repository
--------------------------
-Clone the canonical ASF repo using this command. The `--origin` option tells git to name the remote `apache` instead
-of the default, `origin`; this will reduce ambiguity when we later add a second remote upstream.
+Follow [these instructions]({{site.path.guide}}/dev/code/submodules.html) to configure your local repositories.
+Make sure the canonical ASF repo is enabled as that is where you'll need to push to merge changes,
+and that you are able to fetch pull-requests.
- git clone --origin apache https://git-wip-us.apache.org/repos/asf/incubator-brooklyn.git
+Once that is done, run `git fetch --all` to update from all remote repositories - you will see all the pull requests appear:
-Add a second remote, for the GitHub repository.
-
- git remote add github https://github.com/apache/incubator-brooklyn.git
-
-For the GitHub remote, add an additional `fetch` reference which will cause
-every pull request to be made available as a remote branch in your workspace.
-
- git config --local --add remote.github.fetch '+refs/pull/*/head:refs/remotes/github/pr/*'
-
-Finally, run `git fetch --all` to update from all remote repositories - you will see all the pull requests appear:
-
- * [new ref] refs/pull/98/head -> github/pr/98
- * [new ref] refs/pull/99/head -> github/pr/99
+ * [new ref] refs/pull/98/head -> upstream/pr/1234
+ * [new ref] refs/pull/99/head -> upstream/pr/1235
Merging a pull request
@@ -63,9 +53,9 @@ Fetch the latest remote branches, which will cause a remote branch for the PR to
git fetch --all
-If you want to inspect the PR and/or run tests, check out the branch:
+If you want to inspect a particular PR and/or run tests, check out the branch:
- git checkout github/pr/1234
+ git checkout upstream/pr/1234
To perform the merge, first update your master branch to the latest:
@@ -74,8 +64,8 @@ To perform the merge, first update your master branch to the latest:
Then merge and push:
- git merge --no-ff -m 'This closes #1234' github/pr/1234
- git push apache master
+ git merge --no-ff -m 'This closes #1234' upstream/pr/1234
+ git push apache-git master
Note that this commit message is important, as this is what will trigger the
pull request to be automatically closed, and the `--no-ff` means that a merge
@@ -87,13 +77,13 @@ Alternative options
### Adding the remote reference to the contributor's repository
-Fetch the branch of the user you want to merge from
+Fetch the branch of the user you want to merge from (replacing `-PROJECT` as appropriate):
- git fetch https://github.com/user-to-merge-from/incubator-brooklyn.git branch-to-merge-from
+ git fetch https://github.com/user-to-merge-from/brooklyn-PROJECT.git branch-to-merge-from
-If you commonly merge from a particular user, you'll want to add their repo as a remote to make fetching branches easier.
+If you commonly merge from a particular user, you'll want to add their repo as a remote to make fetching branches easier:
- git remote add user-to-merge-from https://github.com/user-to-merge-from/incubator-brooklyn.git
+ git remote add user-to-merge-from https://github.com/user-to-merge-from/brooklyn-PROJECT.git
git fetch user-to-merge-from
@@ -110,9 +100,9 @@ Apply the patch preserving the original author:
Additional information
----------------------
-Particularly for new committers, you may find the following information useful:
+Particularly for new committers, you may find the following ASF information useful:
-* [Guide for new project
- committers](https://www.apache.org/dev/new-committers-guide.html)
+* [Guide for new project committers](https://www.apache.org/dev/new-committers-guide.html)
* [Committers FAQ](https://www.apache.org/dev/committers.html)
* [Git at Apache](https://git-wip-us.apache.org/)
+
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/b0458432/website/developers/how-to-contribute.md
----------------------------------------------------------------------
diff --git a/website/developers/how-to-contribute.md b/website/developers/how-to-contribute.md
index 0c39521..91a1d5a 100644
--- a/website/developers/how-to-contribute.md
+++ b/website/developers/how-to-contribute.md
@@ -18,7 +18,7 @@ process of making contributions to the Apache Brooklyn code base.
</div>
<div class="panel-body" markdown="1">
-* Pull request to [GitHub](http://github.com/apache/incubator-brooklyn).
+* Pull request to the relevant [GitHub](http://github.com/apache/?query=brooklyn) project
* Sign the [Apache CLA](https://www.apache.org/licenses/#clas) if it's non-trivial.
* For bigger changes, open a [Jira](https://issues.apache.org/jira/browse/BROOKLYN)
and/or [email the list](../community/mailing-lists.html).
@@ -56,8 +56,9 @@ existing issue anyway.
### 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)
+This is our preferred way for contributing code. Our root GitHub repository is located at
+[https://github.com/apache/brooklyn](https://github.com/apache/brooklyn) with most of the code in one of the subprojects.
+You can checkout and PR against just one of the projects listed there. See the README in our root repository for information on subprojects.
Your commit messages must properly describes the changes that have been made and their purpose
([here are some guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)). If your
@@ -96,9 +97,12 @@ easily understood.
### Contributing without using GitHub
If you prefer to not use GitHub, then that is fine - we are also happy to accept patches attached to a Jira issue.
-Our canonical repository is located at `https://git-wip-us.apache.org/repos/asf/incubator-brooklyn.git`; for example:
+Our canonical root repository is located at `https://git-wip-us.apache.org/repos/asf/brooklyn.git` with others
+in `brooklyn-*.git`; for example:
- $ git clone https://git-wip-us.apache.org/repos/asf/incubator-brooklyn.git
+{% highlight bash %}
+$ git clone https://git-wip-us.apache.org/repos/asf/brooklyn-server.git
+{% endhighlight %}
When producing patches, please use `git format-patch` or a similar mechanism - this will ensure that you are properly
attributed as the author of the patch when a committer merges it.
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/b0458432/website/developers/links.md
----------------------------------------------------------------------
diff --git a/website/developers/links.md b/website/developers/links.md
index e684e1c..d9dde26 100644
--- a/website/developers/links.md
+++ b/website/developers/links.md
@@ -8,15 +8,13 @@ menu_proxy_for: index.md
Handy places:
-* **Code** is in Github at [https://github.com/apache/incubator-brooklyn/](https://github.com/apache/incubator-brooklyn/)
+* **Code** is in Github at [https://github.com/apache/brooklyn/](https://github.com/apache/brooklyn/)
* **Issues** are in Jira at [https://issues.apache.org/jira/browse/BROOKLYN/](https://issues.apache.org/jira/browse/BROOKLYN/)
* **Maven repositories** are:
* [Apache releases]({{ apache_releases_repo_groupid_url }})
* [Apache snapshots]({{ apache_snapshots_repo_groupid_url }})
- * Other repositories are at [http://developers.cloudsoftcorp.com/download/maven2/](http://developers.cloudsoftcorp.com/download/maven2/) for releases
- and [http://ccweb.cloudsoftcorp.com/maven/libs-snapshot-local/](http://ccweb.cloudsoftcorp.com/maven/libs-snapshot-local/) for snapshots
-
+
* **CI server** is a jenkins server at: [https://builds.apache.org/job/incubator-brooklyn-master-build/](https://builds.apache.org/job/incubator-brooklyn-master-build/)
[2/2] brooklyn-docs git commit: This closes #2
Posted by he...@apache.org.
This closes #2
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/4e4aed4b
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/4e4aed4b
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/4e4aed4b
Branch: refs/heads/master
Commit: 4e4aed4b5a47772b18d0d047858f796685a27c4e
Parents: f1da175 b045843
Author: Alex Heneveld <al...@cloudsoftcorp.com>
Authored: Tue Feb 2 00:42:50 2016 +0000
Committer: Alex Heneveld <al...@cloudsoftcorp.com>
Committed: Tue Feb 2 00:42:50 2016 +0000
----------------------------------------------------------------------
README.md | 20 +++---
_build/build.sh | 6 +-
_build/htmlproof-brooklyn.sh | 1 -
_build/serve-public-site.sh | 2 +-
_includes/base-head.html | 6 +-
_includes/footer.html | 2 +-
_includes/topmenu.html | 4 +-
_layouts/website-landing.html | 2 +-
guide/dev/code/submodules.md | 69 +++++++++++++-------
website/community/how-to-contribute-docs.md | 3 +-
.../committers/merging-contributed-code.md | 48 ++++++--------
website/developers/how-to-contribute.md | 14 ++--
website/developers/links.md | 6 +-
13 files changed, 100 insertions(+), 83 deletions(-)
----------------------------------------------------------------------