[Gluster-devel] Gluster Programmers' Guide

[Jay Vyas]

Thanks jeff !!!  this will be very useful !

- Might i suggest using git + docbook for this?

- I dont mind to set up the project on glusterforge along with the initial
docbook format to get things rolling.

- Both Bigtop and HBase have used docbook, and I really like the results:
It glues docs in with the dev culture and helps to make the "keeping the
wiki up to date" problem a thing of the past.
For example, you can see that the docbook docs in the source code:
https://github.com/apache/hbase/tree/trunk/src/main/docbkx are reflected
into the hbase docs: http://hbase.apache.org/book.html






On Tue, Jan 7, 2014 at 2:50 PM, Paul Cuzner <pcuzner at redhat.com> wrote:

> This is a great initiative Jeff.
>
>
> ------------------------------
>
> *From: *"Jeffrey Darcy" <jdarcy at redhat.com>
> *To: *"Gluster Devel" <gluster-devel at nongnu.org>
> *Sent: *Wednesday, 8 January, 2014 5:26:34 AM
> *Subject: *[Gluster-devel] Gluster Programmers' Guide
>
>
> One of my projects for this year is to create a GlusterFS Programmers'
> Guide.  This will include information on:
>
> * General architecture
>
> * Internal APIs
>
> * Internals of various translators
>
> * Building and debugging
>
> Basically, it should cover everything a programmer needs in order to be
> productive working on GlusterFS code.  As a first (small) step, I've
> created an outline here:
>
>     http://goo.gl/3jbxgk
>
> Anyone should be able to add comments.  Please feel free to do so, e.g. to
> add sections I've missed.  Also, with this many sections and each one
> requiring *at least* a page or two (much more in some cases), this looks
> like it will be 200+ pages.  If you're interested in writing or
> collaborating on one of the sections, please let me know either in a
> comment or by sending me email.
>
> _______________________________________________
> Gluster-devel mailing list
> Gluster-devel at nongnu.org
> https://lists.nongnu.org/mailman/listinfo/gluster-devel
>
>
>
> _______________________________________________
> Gluster-devel mailing list
> Gluster-devel at nongnu.org
> https://lists.nongnu.org/mailman/listinfo/gluster-devel
>
>


-- 
Jay Vyas
http://jayunit100.blogspot.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://supercolony.gluster.org/pipermail/gluster-devel/attachments/20140107/3baccaa6/attachment.html>