<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="Content-Type">
</head>
<body bgcolor="#FFFFFF" text="#000000">
docbook didn't work last time it was used. Perhaps asciidoc would be
more open to collaboration.<br>
<br>
I'd be willing to throw some effort at documenting what I can figure
out, but not if it's in some obscure xml format.<br>
<br>
<div class="moz-cite-prefix">On 01/07/2014 12:05 PM, Jay Vyas wrote:<br>
</div>
<blockquote
cite="mid:CAAu13zH8AYKm4ThpQyu89AX6hLSWG52XJXxTv2GBgXy2QijxLQ@mail.gmail.com"
type="cite">
<div dir="ltr">
<div>Thanks jeff !!! this will be very useful ! <br>
<br>
- Might i suggest using git + docbook for this? <br>
<br>
- I dont mind to set up the project on glusterforge along with
the initial docbook format to get things rolling.<br>
<br>
- 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.<br>
For example, you can see that the docbook docs in the source
code: <a moz-do-not-send="true"
href="https://github.com/apache/hbase/tree/trunk/src/main/docbkx">https://github.com/apache/hbase/tree/trunk/src/main/docbkx</a>
are reflected into the hbase docs: <a moz-do-not-send="true"
href="http://hbase.apache.org/book.html">http://hbase.apache.org/book.html</a><br>
</div>
<div><br>
</div>
<div><br>
</div>
<div><br>
<br>
</div>
</div>
<div class="gmail_extra"><br>
<br>
<div class="gmail_quote">On Tue, Jan 7, 2014 at 2:50 PM, Paul
Cuzner <span dir="ltr"><<a moz-do-not-send="true"
href="mailto:pcuzner@redhat.com" target="_blank">pcuzner@redhat.com</a>></span>
wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0
.8ex;border-left:1px #ccc solid;padding-left:1ex">
<div>
<div style="font-size:12pt;font-family:lucida
console,sans-serif">
<div>This is a great initiative Jeff. <br>
</div>
<div><br>
</div>
<div><br>
</div>
<hr>
<blockquote
style="padding-left:5px;font-size:12pt;font-style:normal;margin-left:5px;font-family:Helvetica,Arial,sans-serif;text-decoration:none;font-weight:normal;border-left:2px
solid #1010ff">
<b>From: </b>"Jeffrey Darcy" <<a
moz-do-not-send="true"
href="mailto:jdarcy@redhat.com" target="_blank">jdarcy@redhat.com</a>><br>
<b>To: </b>"Gluster Devel" <<a
moz-do-not-send="true"
href="mailto:gluster-devel@nongnu.org"
target="_blank">gluster-devel@nongnu.org</a>><br>
<b>Sent: </b>Wednesday, 8 January, 2014 5:26:34 AM<br>
<b>Subject: </b>[Gluster-devel] Gluster Programmers'
Guide
<div>
<div class="h5"><br>
<div><br>
</div>
One of my projects for this year is to create a
GlusterFS Programmers' Guide. This will include
information on:<br>
<div><br>
</div>
* General architecture<br>
<div><br>
</div>
* Internal APIs<br>
<div><br>
</div>
* Internals of various translators<br>
<div><br>
</div>
* Building and debugging<br>
<div><br>
</div>
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:<br>
<div><br>
</div>
<a moz-do-not-send="true"
href="http://goo.gl/3jbxgk" target="_blank">http://goo.gl/3jbxgk</a><br>
<div><br>
</div>
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.<br>
<div><br>
</div>
_______________________________________________<br>
Gluster-devel mailing list<br>
<a moz-do-not-send="true"
href="mailto:Gluster-devel@nongnu.org"
target="_blank">Gluster-devel@nongnu.org</a><br>
<a moz-do-not-send="true"
href="https://lists.nongnu.org/mailman/listinfo/gluster-devel"
target="_blank">https://lists.nongnu.org/mailman/listinfo/gluster-devel</a><br>
</div>
</div>
</blockquote>
<div><br>
</div>
</div>
</div>
<br>
_______________________________________________<br>
Gluster-devel mailing list<br>
<a moz-do-not-send="true"
href="mailto:Gluster-devel@nongnu.org">Gluster-devel@nongnu.org</a><br>
<a moz-do-not-send="true"
href="https://lists.nongnu.org/mailman/listinfo/gluster-devel"
target="_blank">https://lists.nongnu.org/mailman/listinfo/gluster-devel</a><br>
<br>
</blockquote>
</div>
<br>
<br clear="all">
<br>
-- <br>
Jay Vyas<br>
<a moz-do-not-send="true" href="http://jayunit100.blogspot.com"
target="_blank">http://jayunit100.blogspot.com</a>
</div>
<br>
<fieldset class="mimeAttachmentHeader"></fieldset>
<br>
<pre wrap="">_______________________________________________
Gluster-devel mailing list
<a class="moz-txt-link-abbreviated" href="mailto:Gluster-devel@nongnu.org">Gluster-devel@nongnu.org</a>
<a class="moz-txt-link-freetext" href="https://lists.nongnu.org/mailman/listinfo/gluster-devel">https://lists.nongnu.org/mailman/listinfo/gluster-devel</a>
</pre>
</blockquote>
<br>
</body>
</html>