Gluster users - Mar 2015 - Revamping the GlusterFS Documentation...

Hi John,

Thank you, thats a really valuable feedback. 
We are working on updating the documentation and will ensure to address this
gap.

Thanks and regards,
Shravan



-------- Forwarded Message --------
Subject: 	Re: [Gluster-users] Revamping the GlusterFS Documentation...
Date: 	Wed, 25 Mar 2015 08:59:10 +1100
From: 	John Gardeniers <jgardeniers at objectmastery.com>
To: 	gluster-users at gluster.org



Hi Shravan,

Having recently set up geo-replication of Gluster v3.5.3 I can tell you 
that there is effectively almost no documentation. The documentation 
that does exists is primarily focused on describing the differences 
between the current and previous versions. That's completely useless to 
someone wanting to set it up for the first time and not a whole lot 
better for someone who has upgraded. The first, and perhaps most 
crucial, piece of information that's missing is installation 
requirements. Nowhere have I been able to find out exactly which 
components are required on either the master or the slave. In my case 
this was determined by pure trial and error. i.e. Install what I think 
should be needed and then continue installing components until it starts 
to work. Even once that part is done, there is a LOT of documentation 
missing. I recall that when I first set up geo-replication (v3.2 or 
v3.3?) I was able to follow clear and simple step by step instructions 
that almost guaranteed success.

regards,
John


On 23/03/15 18:01, Shravan Chandrashekar wrote:
> *Hi All, *
>
> *"The Gluster Filesystem documentation is not user friendly and 
> fragmented" and this has been the feedback we have been receiving. *
>
> *We got back to our drawing board and blueprints and realized that the 
> content was scattered at various places. These include: *
>
> *[Static HTML] http://www.gluster.org/documentation/ *
> *[Mediawiki] http://www.gluster.org/community/documentation/ *
> *[In-source] https://github.com/gluster/glusterfs/tree/master/doc *
> *[Markdown] https://github.com/GlusterFS/Notes *
>
> *and so on
 *
>
> *Hence, we started by curating content from various sources including 
> gluster.org static HTML documentation, glusterfs github repository, *
> *various blog posts and the Community wiki. We also felt the need to 
> improve the community member's experience with Gluster documentation. 
> This led us to put some thought into the user interface. As a result 
> we came up with a page which links all content into a single landing 
> page: *
>
> *http://www.gluster.org/community/documentation/index.php/Staged_Docs *
>
> *This is just our first step to improve our community docs and enhance 
> the community contribution towards documentation. I would like to 
> thank Humble Chirammal and Anjana Sriram for the suggestions and 
> directions during the entire process. I am sure there is lot of scope 
> for improvement. *
> *Hence, request you all to review the content and provide your 
> suggestions. *
>
> Regards,
> Shravan Chandra
>
>
> ______________________________________________________________________
> This email has been scanned by the Symantec Email Security.cloud service.
> For more information please visit http://www.symanteccloud.com
> ______________________________________________________________________
>
>
> _______________________________________________
> Gluster-users mailing list
> Gluster-users at gluster.org
> http://www.gluster.org/mailman/listinfo/gluster-users


-------------- next part --------------
_______________________________________________
Gluster-users mailing list
Gluster-users at gluster.org
http://www.gluster.org/mailman/listinfo/gluster-users

Shravan Chandrashekar [Thu, Mar 26, 2015 at 02:10:59AM
-0400]:
> Hi John,
> 
> Thank you, thats a really valuable feedback. 
> We are working on updating the documentation and will ensure to address
this gap.
That's much appreciated Shravan!

I can add from my side: if the source is really open and easily
changable (as in github PR or similar), I think people want and will
contribute in improving it.

However I think there need to be some rough table of contents or
structure given by the project lead.

My 50 KRW,

Nico

-- 
New PGP key: 659B 0D91 E86E 7E24 FD15  69D0 C729 21A1 293F 2D24