[Gluster-devel] Improved developer documentation

[Kaushal M]

That will be a good thing to do, I'll push a patch with it soon.

It would be great if we were to make doc/hacker-guide the central
location for devel docs and publish it online. This way more
developers will hopefully contribute it.

On Wed, Mar 12, 2014 at 11:27 PM, Thiago da Silva <thiago at redhat.com> wrote:
> Yes, such a document is really nice. Could we also add it as a markdown
> in the doc/hacker-guide directory?
>
> On Wed, 2014-03-12 at 10:30 -0700, Anand Avati wrote:
>> Great initiative Kaushal! Making the life of newcomers as frictionless
>> as possible is always most welcome. I would suggest having a single
>> workflow document (just replace the content of Development_Work_Flow
>> as a lot of people would have bookmarked the link etc.)
>>
>>
>> Thanks!
>>
>>
>> On Wed, Mar 12, 2014 at 5:34 AM, Kaushal M <kshlmster at gmail.com>
>> wrote:
>>         Hello list,
>>
>>         The current description GlusterFS development workflow on [1]
>>         is not
>>         easy to follow for new contributors and hasn't been updated in
>>         some
>>         time. This makes it a hard for new contributors to start.
>>
>>         To make it easier for newer contributors, I've created a new
>>         simplified workflow document at [2]. I believe this is much
>>         easier for
>>         a newcomer to follow and will help GlusterFS get new
>>         contributors.
>>         Most of this page links to [1] for additional details.
>>
>>         Apart from this, I would like to also rewrite [1] to make it
>>         more
>>         structured and easier to consume, while still giving more
>>         information
>>         than [2]. I will do this as I get time.
>>
>>         I've also created a new Building GlusterFS page [3] which will
>>         provide
>>         up to date instructions for building GlusterFS. This currently
>>         gives
>>         information for building GlusterFS from source and building
>>         RPMs. I
>>         hope additional sections on building packages.
>>
>>         I also hope to add documentation on debugging GlusterFS soon.
>>
>>         Comments and contributions to the new documentation are
>>         welcome. :-)
>>
>>         ~kaushal
>>
>>         [1] -
>>         http://www.gluster.org/community/documentation/index.php/Development_Work_Flow
>>         [2] -
>>         http://gluster.org/community/documentation/index.php/Simplified_dev_workflow
>>         [3] -
>>         http://www.gluster.org/community/documentation/index.php/Building_GlusterFS
>>
>>         _______________________________________________
>>         Gluster-devel mailing list
>>         Gluster-devel at nongnu.org
>>         https://lists.nongnu.org/mailman/listinfo/gluster-devel
>>
>>
>> _______________________________________________
>> Gluster-devel mailing list
>> Gluster-devel at nongnu.org
>> https://lists.nongnu.org/mailman/listinfo/gluster-devel
>
>