[Gluster-devel] Gluster Programmers' Guide

Jeffrey Darcy jdarcy at redhat.com
Tue Jan 7 20:14:33 UTC 2014


----- Original Message ----- 

> 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

The plan is to transition to something like that, though it hasn't been
settled exactly which "like that" to use. Apparently we've been migrating to
asciidoc + middleman for the web site and documentation project, so that would
seem to be the front-running solution.  Definitely something compatible with
our existing review/source-control tools would be a big win.





More information about the Gluster-devel mailing list