On 02/21/2014 10:27 PM, BGM wrote:
It might be very helpful to have a wiki next to this mailing list,
where all the good experience, all the proved solutions for "situations"
that are brought up here, could be gathered in a more
permanent and straight way.
+1. It would be very useful to evolve an operations guide for GlusterFS.
.
To your questions I would add:
what's best practice in setting options for performance and/or integrity...
(yeah, well, for which use case under which conditions)
a mailinglist is very helpful for adhoc probs and questions,
but it would be nice to distill the knowledge into a permanent, searchable form.
.
sure anybody could set up a wiki, but...
it would need the acceptance and participation of an active group
to get best results.
so IMO the appropriate place would be somewhere close to gluster.org?
.
Would be happy to carry this in doc/ folder of glusterfs.git and collaborate on it if a lightweight documentation format like markdown or asciidoc is used for evolving this guide.
I haven't worked with neither of them,
on the very first glance asciidoc looks easier to me.
(assuming it is either or ?)
and (sorry for being flat, i m op not dev ;-) you suggest everybody sets up a git from where you
pull, right?
No need to setup a git on your own. We use the development workflow [1]
for submitting patches to documentation too.
well, wouldn't a wiki be much easier? both, to contribute to and to access the information?
(like wiki.debian.org?)
The git based solution might be easier to start of with,
but would it reach a big enough community?
Documentation in markdown or asciidoc is rendered well by github. One of
the chapters in our admin guide does get rendered like this [2].
Wouldn't a wiki also have a better PR/marketing effect (by being easier to access)?
just a thought...
We can roll out the content from git in various formats (like pdf, html
etc.) as both asciidoc/markdown can be converted to various formats. The
advantage of a git based workflow is that it becomes easy to review
changes through tools like gerrit and can also help in keeping false
content/spam out of the way.
Having said that, feel free to use tools of your choice. We can just go
ahead and use whatever is easy for most of us :). At the end of the day,
evolving this guide is more important than the tools that we choose to
use in the process.
Cheers,
Vijay
[1]
http://www.gluster.org/community/documentation/index.php/Development_Work_Flow
[2]
https://github.com/gluster/glusterfs/blob/master/doc/admin-guide/en-US/markdown/admin_setting_volumes.md
Bernhard
-Vijay
_______________________________________________
Gluster-users mailing list
Gluster-users@xxxxxxxxxxx
http://supercolony.gluster.org/mailman/listinfo/gluster-users
