From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Mon, 23 Feb 2015 18:05:12 +0000 (-0500)
Subject: README.md, contrib-guide.md: explain branches
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=89415a666d7aeec1e384459a78753253dfb21912;p=lttng-docs.git

README.md, contrib-guide.md: explain branches
---

diff --git a/README.md b/README.md
index 4286e5e..c42cc38 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,8 @@ This is the official repository of the
 To contribute:
 
   1. Fork this repo
-  2. Make your change, following the [contributor's guide](contrib-guide.md)
-  3. Create a pull request
+  2. Checkout the appropriate branch (`stable-2.x` or `master`)
+  3. Make your change, following the [contributor's guide](contrib-guide.md)
+  4. Create a pull request
 
 Thanks for your contributions and fixes!
diff --git a/contrib-guide.md b/contrib-guide.md
index 456c120..f3cd76b 100644
--- a/contrib-guide.md
+++ b/contrib-guide.md
@@ -6,8 +6,17 @@ Documentation's source. Make sure you read it thoroughly before
 contributing a change.
 
 
-structure
----------
+branches
+--------
+
+The online documentation published at <http://lttng.org/docs/> is always
+compiled from the sources of this repository's latest stable branch.
+The `master` branch contains the current documentation of the upcoming
+LTTng release.
+
+
+structure of sources
+--------------------
 
 `toc/docs.yml` is a YAML tree of all chapters, sections and subsections.
 It indicates which unique ID is linked to which position in the