couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Couchdb Wiki] Update of "Documentation" by DaveCottlehuber
Date Thu, 09 Aug 2012 08:31:26 GMT
Dear Wiki user,

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

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

   * A [[http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html|cheatsheet]] for both
Sphinx and rst
   * If you want to regenerate the documentation into HTML, the [[http://sphinx.pocoo.org/index.html|Sphinx]]
guide may be of interest
  
- TODO: describe how to fork a suitable repo, edit the .rst file either directly 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 computer, and then
send a pull request.
+ 
+ === Editing Documentation via GitHub ===
+ 
+ [[https://github.com|GitHub]] supports displaying .rst files with correct formatting directly
in their web UI. This makes quick updates very easy, using the mirrored ASF [[https://github.com/apache/couchdb|CouchDB
git repository]]. Before editing the documentation, get your own editable copy of the 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 mirror, 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 branches from the
drop-down menu.
+  3. The correct branch will depend a lot on where things are in the release 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}}} branch which will eventually be used to generate the next major release. For
example, after 1.2.0, would come 1.3.0.
+ 
  
  == Generating Docs ==
  

Mime
View raw message