<div dir="ltr"><div class="" id="magicdomid2"><span class=""><br></span></div><div class="" id="magicdomid3"><span class=""> </span></div><div class="" id="magicdomid4"><span class="">Hello all,</span></div><div class="" id="magicdomid5"><br></div><div class="" id="magicdomid6"><span class="">The
GlusterFS documentation team is constantly working to improve the
quality, findability, and usefulness of its documentation. Our goal is
to increase community contribution, remove barriers that discourage
contribution and give you the help you need, when and where you need it.
As part of this strategy, we’ve just rolled out the revamped GlusterFS
Documentation: <a href="http://gluster.readthedocs.org">gluster.readthedocs.org</a></span></div><div class="" id="magicdomid7"><br></div><div class="" id="magicdomid8"><span class="">We
started by curating content from various sources including <a href="http://gluster.org">gluster.org</a>
static HTML documentation, various blog posts and the Community wiki. We
used readthedocs service to host the documentation and mkdocs to
convert the Markdown source files to HTML pages. We also put our thought
into classifying the documentation based on their content:</span></div><div class="" id="magicdomid9"><br></div><div class="" id="magicdomid10"><ul class=""><li><span class="">Quick Start Guide : A headstart guide for the beginners.</span></li></ul></div><div class="" id="magicdomid11"><ul class=""><li><span class="">Installation Guide : Step by step instructions to install GlusterFS.</span></li></ul></div><div class="" id="magicdomid12"><ul class=""><li><span class="">Administration Guide : Container for for all administrative actions.</span></li></ul></div><div class="" id="magicdomid13"><ul class=""><li><span class="">Developer Guide : Container for all development related aspects.</span></li></ul></div><div class="" id="magicdomid14"><ul class=""><li><span class="">Upgrade Guide : Contains guides to upgrade from older versions of GlusterFS.</span></li></ul></div><div class="" id="magicdomid15"><ul class=""><li><span class="">Features : Container for all the features of GlusterFS introduced in various versions.</span></li></ul></div><div class="" id="magicdomid16"><ul class=""><li><span class="">GlusterFS Tools : Contains information about the tools used in GlusterFS.</span></li></ul></div><div class="" id="magicdomid17"><ul class=""><li><span class="">Troubleshooting Guide : Container for basic troubleshooting and debugging guides.</span></li></ul></div><div class="" id="magicdomid18"><ul class=""><li><span class="">Images : Container for images (in .jpg or .png format) that are present inline the documentation pages.</span></li></ul></div><div class="" id="magicdomid19"><br></div><div class="" id="magicdomid20"><span class="">Doing so, we gain these benefits:</span></div><div class="" id="magicdomid21"><br></div><div class="" id="magicdomid22"><ul class=""><li><span class="">Version based browsable documentation</span></li></ul></div><div class="" id="magicdomid23"><ul class=""><li><span class="">More targeted content</span></li></ul></div><div class="" id="magicdomid24"><ul class=""><li><span class="">Less duplication</span></li></ul></div><div class="" id="magicdomid25"><ul class=""><li><span class="">Faster updates</span></li></ul></div><div class="" id="magicdomid26"><br></div><div class="" id="magicdomid27"><span class="">Whats changing for community members?</span></div><div class="" id="magicdomid28"><br></div><div class="" id="magicdomid29"><span class="">A very simplified contribution workflow. </span></div><div class="" id="magicdomid30"><br></div><div class="" id="magicdomid31"><span class="">- How to Contribute?</span></div><div class="" id="magicdomid32"><br></div><div class="" id="magicdomid33"><span class="">Contributing
to the documentation requires a github account. To edit on github, fork
the repository (see top-right of the screen, under your username). You
will then be able to make changes easily. Once done, you can create a
pull request and get the changes reviewed and merged into the official
repository.</span></div><div class="" id="magicdomid538"><span class="">With
this simplified workflow, the documentation is no longer maintained in
gluster/glusterfs/docs directory but it has a new elevated status in the
form of a new project: gluster/glusterdocs (</span><span class=""><a href="https://github.com/gluster/glusterdocs%29">https://github.com/gluster/glusterdocs)</a></span><span class=""> and currently this project is being maintained by Anjana Sriram, Shravan and Humble.</span></div><div class="" id="magicdomid35"><br></div><div class="" id="magicdomid36"><span class="">- What to Contribute</span></div><div class="" id="magicdomid37"><br></div><div class="" id="magicdomid38"><span class="">Really,
anything that you think has value to the GlusterFS developer community.
While reading the docs you might find something incorrect or outdated.
Fix it! Or maybe you have an idea for a tutorial, or for a topic that
isn’t covered to your satisfaction. Create a new page and write it up!</span></div><div class="" id="magicdomid39"><br></div><div class="" id="magicdomid40"><span class="">Whats Next?</span></div><div class="" id="magicdomid41"><br></div><div class="" id="magicdomid301"><span class=""><b>Since
the GlusterFS documentation has a new face-lift, MediaWiki will no
longer be editable but will only be READ ONLY view mode. Hence, all the
work-in-progress design notes which were maintained on MediaWiki will be
ported to the GitHub repository and placed in "Feature Plans" folder.
So, when you want to upload your work in progess documents you must do a
pull request after the changes are made. This outlines the change in
workflow as compared to MediaWiki.</b></span></div><div class="" id="magicdomid303"><br></div><div class="" id="magicdomid310"><span class="">A proposal:</span></div><div class="" id="magicdomid46"><br></div><div class="" id="magicdomid350"><span class="">Another way to maintain work-in-progress documents in Google docs (o</span><span class="">r any other colloborative editing tool)</span><span class="">
and link them as an index entry in Feature Plans page on GitHub. This
can be an excellent way to track a document through multiple rounds of
collaborative editing in real time.</span></div><div class="" id="magicdomid49"><br></div><div class="" id="magicdomid50"><br></div><div class="" id="magicdomid51"><br></div><div class="" id="magicdomid52"><span class="">Stay
tuned for a more detailed information about the new contribution
workflow, which will be posted on the new documentation website (i.e.
<a href="http://gluster.readthedocs.org">gluster.readthedocs.org</a>)</span></div><div class="" id="magicdomid53"><br></div><div class="" id="magicdomid465"><span class="">We love to hear your feedback on this. Any suggestions/comments regarding this would help !</span></div><div class="" id="magicdomid353"><br></div><div><div class="gmail_signature"><div dir="ltr"><div>--Humble<br></div><br></div></div></div>
</div>