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] Trivial Update of "Documentation" by DaveCottlehuber
Date Thu, 09 Aug 2012 08:44:48 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=3&rev2=4

  
  === 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:
+ [[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]].
+ 
+ ==== Get your own Fork ====
+ 
+ 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}}
  
@@ -36, +40 @@

   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.
  
+ TODO: ensure we have a documentation url for latest and each release on website
+ 
+ ==== Editing inside GitHub ====
+ 
+ Now that you've got a suitable branch selected
+ 
+  * Browse into {{{share/docs/sphinx-docs}}}
+  * Identify the file you want to edit/alter.
+ 
+ {{attachment:github_rst_formatted_view.png}}
+ 
+  * Switch to raw view and start editing! Note that you can switch back between source and
edit view without losing your content.
+ 
+ {{attachment:github_raw_view.png}}
+ 
+  * Once you're happy with the changes, add a suitable brief commit message:
+ 
+ {{attachment:github_rst_commit_msg.png}}
+ 
+  * Send a pull request and the committers will pick up your documentation changes, and your
Karma will be increased!
  
  == Generating Docs ==
  

Mime
View raw message