README.md, contrib-guide.md: explain branches
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Mon, 23 Feb 2015 18:05:12 +0000 (13:05 -0500)
committerPhilippe Proulx <eeppeliteloop@gmail.com>
Mon, 23 Feb 2015 18:05:12 +0000 (13:05 -0500)
README.md
contrib-guide.md

index 4286e5e21ea99041f05688e8e9fdcad27f28e8b3..c42cc38f57af7c5a97d8ffa849070790629db140 100644 (file)
--- 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!
index 456c120802282fd7189eb7d12d49bb013ad0144f..f3cd76b646926826b75b652b4c36e7eae0446f26 100644 (file)
@@ -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
This page took 0.026805 seconds and 4 git commands to generate.