Re: [Gluster-users] [Gluster-devel] Revamping the GlusterFS Documentation...
I think we also need version based documentation something similar to http://guides.emberjs.com/v1.11.0/ -- regards Aravinda http://aravindavk.in On 04/09/2015 07:24 PM, Sankarshan Mukhopadhyay wrote: On Mon, Mar 23, 2015 at 12:31 PM, Shravan Chandrashekar schan...@redhat.com wrote: 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. This is a strong first step. Thank you for pulling this together. The feedback at https://www.gluster.org/pipermail/gluster-users/2015-March/021275.html would indicate that there is a need to put together a blueprint for a workflow that makes it more easy to contribute, administer and maintain in a state of publication-readiness. ___ Gluster-users mailing list Gluster-users@gluster.org http://www.gluster.org/mailman/listinfo/gluster-users
Re: [Gluster-users] [Gluster-devel] Revamping the GlusterFS Documentation...
On Mon, Mar 23, 2015 at 12:31 PM, Shravan Chandrashekar schan...@redhat.com wrote: 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. This is a strong first step. Thank you for pulling this together. The feedback at https://www.gluster.org/pipermail/gluster-users/2015-March/021275.html would indicate that there is a need to put together a blueprint for a workflow that makes it more easy to contribute, administer and maintain in a state of publication-readiness. -- sankarshan mukhopadhyay https://about.me/sankarshan.mukhopadhyay ___ Gluster-users mailing list Gluster-users@gluster.org http://www.gluster.org/mailman/listinfo/gluster-users
Re: [Gluster-users] [Gluster-devel] Revamping the GlusterFS Documentation...
Happy to hear that there are plans to improve the GlusterFS documentation! I've realized myself that I once wanted to contribute to the docs, but wasn't sure where to. If the diverse sources of gluster's docs are now going to be merged to a central entity, that would very likely improve contributions from the community. On 03/23/2015 10:34 PM, Justin Clift wrote: * Gluster Ant Logo image - The first letter REALLY looks like a C (to me), not a G. Reads as Cluster for me... I personally also prefer the font used for the Gluster community logo in the upper left corner. It feels a bit more like a proper trademark. I like that :) Something else I wanted to mention is, that I found it very confusing / intimidating that some articles referred to specific version numbers in their title. For example Gluster 3.2: Migrating Volumes [1]. I wasn't sure if I should follow instructions listed there, if I'm using a different gluster version (e.g. 3.4). Especially, because there is one for 3.1, for example. So I tried to replace 3.2 with 3.4 in the URL, as I would have expected a naming convention in that case. Search also didn't list anything. So, in the end, I gave up and used the 3.2 docs. I assume it's so because nothing has changed with Migrating Volumes, for example since 3.2 - but how will I know if the docs I find apply to my version? That's something I think might be nice if that's solved somehow in the new docs. Thanks and regards, Pb == References: [1] http://www.gluster.org/community/documentation/index.php/Gluster_3.2:_Migrating_Volumes ___ Gluster-users mailing list Gluster-users@gluster.org http://www.gluster.org/mailman/listinfo/gluster-users
Re: [Gluster-users] [Gluster-devel] Revamping the GlusterFS Documentation...
Yes, We are thinking about a front/landing page for the documentation with better UI/UX. The minor changes that you had suggested, have been made :) -Shravan - Original Message - From: Justin Clift jus...@gluster.org To: Shravan Chandrashekar schan...@redhat.com Cc: gluster-users@gluster.org, gluster-de...@gluster.org, Anjana Suparna Sriram asri...@redhat.com, s...@redhat.com Sent: Tuesday, March 24, 2015 3:04:39 AM Subject: Re: [Gluster-devel] Revamping the GlusterFS Documentation... On 23 Mar 2015, at 07:01, Shravan Chandrashekar schan...@redhat.com 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. Looks like a good effort. Is the general concept for this to become the front/landing page for the main wiki? Also some initial thoughts: * Gluster Ant Logo image - The first letter REALLY looks like a C (to me), not a G. Reads as Cluster for me... That aside, it looks really good. :) * Getting Started section ... move it up maybe, before the Terminology / Architecture / Additional Resources bit This is to make it more obvious for new people. * Terminologies should probably be Terminology, as Terminology is kind of both singular and plural. * All that Developers need to know → Everything Developers need to know They're my first thoughts anyway. :) + Justin -- GlusterFS - http://www.gluster.org An open source, distributed file system scaling to several petabytes, and handling thousands of clients. My personal twitter: twitter.com/realjustinclift ___ Gluster-users mailing list Gluster-users@gluster.org http://www.gluster.org/mailman/listinfo/gluster-users
Re: [Gluster-users] [Gluster-devel] Revamping the GlusterFS Documentation...
On 23 Mar 2015, at 07:01, Shravan Chandrashekar schan...@redhat.com 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. Looks like a good effort. Is the general concept for this to become the front/landing page for the main wiki? Also some initial thoughts: * Gluster Ant Logo image - The first letter REALLY looks like a C (to me), not a G. Reads as Cluster for me... That aside, it looks really good. :) * Getting Started section ... move it up maybe, before the Terminology / Architecture / Additional Resources bit This is to make it more obvious for new people. * Terminologies should probably be Terminology, as Terminology is kind of both singular and plural. * All that Developers need to know → Everything Developers need to know They're my first thoughts anyway. :) + Justin -- GlusterFS - http://www.gluster.org An open source, distributed file system scaling to several petabytes, and handling thousands of clients. My personal twitter: twitter.com/realjustinclift ___ Gluster-users mailing list Gluster-users@gluster.org http://www.gluster.org/mailman/listinfo/gluster-users
