[Gluster-devel] GlusterFS Documentation improvements

[Lubomir Rintel]

Hello everyone,

I've found GlusterFS documentation hard to follow. I've often found
resources useful to me only by accident, scattered across the wiki, in
source tree, blogs or presentation slides. Lots of documents were on
the other hand inaccurate or incomplete, maybe just because GlusterFS
development progressed making them obsolete. The more I got involved
with GlusterFS use, the more I wished for a consistent guide/book I
could follow to grasp understanding of ideas behind its architecture
as well as implementation.

I would very much like to help improve the situation (as time would permit).

I'm not sure how, though, and need some help with that. What I'd like
to avoid is clashing with anyone's else work, or preparing patches
that would get immediately refused. I've prepared an short analysis of
current documentation and overview of what would changes make sense to
me:

https://github.com/lkundrak/glusterfs/wiki/Documentation-improvement-ideas

I'd be very thankful for feedback, especially from people that are
working on documentation currently, have plans about changes to it or
are familiar with history behind current situation. "This does not
make any sense," or "Go ahead, do this!" would definitely be
appreciated.

Thank you!
Lubo

-- 
Lubomir Rintel <lubo.rintel at gooddata.com>
GoodData whitespace removal specialist