Mailing-List: contact dev-help@couchdb.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@couchdb.apache.org
Received-SPF: pass (nike.apache.org: domain of john.tigernassau@gmail.com
 designates 209.85.160.180 as permitted sender)
Message-ID: <50637743.1060200@gmail.com>
Date: Wed, 26 Sep 2012 15:44:35 -0600
From: "john.tiger" <john.tigernassau@gmail.com>
User-Agent: Mozilla/5.0 (X11; Linux i686;
 rv:10.0.6esrpre) Gecko/20120817 Icedove/10.0.6
MIME-Version: 1.0
To: dev@couchdb.apache.org
Subject: Re: couch has docs!
References: 
 <CAL+Y1nvgY+ZEkvvX7vpZpFf6V+a5jh0fnoUd68iD-YvFyYRuHA@mail.gmail.com>
In-Reply-To: 
 <CAL+Y1nvgY+ZEkvvX7vpZpFf6V+a5jh0fnoUd68iD-YvFyYRuHA@mail.gmail.com>
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: 7bit

okay, thks - now what is plan - if docs go into /couchdb/docs then 
should stuff in wiki be ported over ?  having both docs and wiki is 
confusing unless really clear what goes into what.


On 09/26/2012 03:02 PM, Dave Cottlehuber wrote:
> Hi,
>
> After much hand-wringing&  gnashing of teeth, we now have a /docs/
> branch in git[1], [2], and available online [3]. A huge thank-you to
> Dirkjan Ochtman, Alexander Shorin, and the tireless Jan&  Noah to make
> this happen. The single biggest thing you can do as thanks, is to send
> us improvements, in any form you feel comfortable, and in any size.
>
> Sending in changes&  fixes should be as easy as 1-2-3:
>
> 1: fork locally with git, or github
> 2: edit the .rst format [7] files either in the slick github UI, or in
> your favourite editor
> 3: send a pull request, mail, jira, or a patch as you prefer
>
> I hopefully documented those steps [4] so please let me know if it
> works. Live Long&  Document!
>
> Notes&  Tips:
> - /docs/ lags master a wee bit, nothing serious
> - feel free to use COUCHDB-1536 for tracking any integration work in
> the /docs/ branch
> - you can use pandoc online [5] to convert from your favourite format
> - it looks like github lets you edit in markdown but send in changes
> in rst format
>
> [1]: https://git-wip-us.apache.org/repos/asf?p=couchdb.git;a=tree;f=share/docs;hb=docs
> [2]: https://github.com/apache/couchdb/tree/docs
> [3]: http://couchdb.readthedocs.org/en/latest/index.html
> [4]: http://wiki.apache.org/couchdb/Documentation
> [5]: http://johnmacfarlane.net/pandoc/try
> [6]: https://issues.apache.org/jira/browse/COUCHDB-1536
> [7]: http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html
>
> A+
> Dave
>