Mailing-List: contact commits-help@couchdb.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@couchdb.apache.org
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
From: Apache Wiki <wikidiffs@apache.org>
To: Apache Wiki <wikidiffs@apache.org>
Date: Thu, 09 Aug 2012 08:31:26 -0000
Message-ID: <20120809083126.72362.48710@eos.apache.org>
Subject: 
 =?utf-8?q?=5BCouchdb_Wiki=5D_Update_of_=22Documentation=22_by_DaveCottleh?=
 =?utf-8?q?uber?=
Auto-Submitted: auto-generated

Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Couchdb Wiki" for c=
hange notification.

The "Documentation" page has been changed by DaveCottlehuber:
http://wiki.apache.org/couchdb/Documentation?action=3Ddiff&rev1=3D2&rev2=3D3

   * A [[http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html|chea=
tsheet]] for both Sphinx and rst
   * If you want to regenerate the documentation into HTML, the [[http://sp=
hinx.pocoo.org/index.html|Sphinx]] guide may be of interest
  =

- TODO: describe how to fork a suitable repo, edit the .rst file either dir=
ectly in github or on your computer, and then send a pull request.
+ TODO: describe how to fork a suitable repo, edit the .rst file on your co=
mputer, and then send a pull request.
+ =

+ =3D=3D=3D Editing Documentation via GitHub =3D=3D=3D
+ =

+ [[https://github.com|GitHub]] supports displaying .rst files with correct=
 formatting directly in their web UI. This makes quick updates very easy, u=
sing the mirrored ASF [[https://github.com/apache/couchdb|CouchDB git repos=
itory]]. Before editing the documentation, get your own editable copy of th=
e repository, and choose the most appropriate branch to work on:
+ =

+ {{attachment:github_fork_and_select_branch.png}}
+ =

+  1. Fork: as you will not have write permission to the ASF CouchDB git mi=
rror, you'll need to make your own fork, or copy. Just click on the {{{fork=
}}} button, and you're done.
+  2. Branch if needed: Once you have your own fork, list the available bra=
nches from the drop-down menu.
+  3. The correct branch will depend a lot on where things are in the relea=
se cycle. In most cases, you'll simply want to pick either the patch branch=
 for the last release (e.g. the 1.2.0 release will have a corresponding 1.2=
.x branch, as shown above), or more often, use the current {{{master}}} bra=
nch which will eventually be used to generate the next major release. For e=
xample, after 1.2.0, would come 1.3.0.
+ =

  =

  =3D=3D Generating Docs =3D=3D
 =20