Re: [Gluster-devel] Inspiration for improving our contributor documentation

2014-07-18 Thread Pranith Kumar Karampuri
On 07/18/2014 06:21 PM, Justin Clift wrote: On 18/07/2014, at 6:52 AM, Kaushal M wrote: These kinds of docs need to indexable and searchable by search engines. Only then will they be useful. I don't think markdown files in the source would be good place for these. The other docs related to sou

Re: [Gluster-devel] Inspiration for improving our contributor documentation

2014-07-18 Thread Justin Clift
On 18/07/2014, at 6:52 AM, Kaushal M wrote: > These kinds of docs need to indexable and searchable by search > engines. Only then will they be useful. I don't think markdown files > in the source would be good place for these. > The other docs related to source/code documentation can be provided i

Re: [Gluster-devel] Inspiration for improving our contributor documentation

2014-07-17 Thread Kaushal M
On Fri, Jul 18, 2014 at 11:39 AM, Pranith Kumar Karampuri wrote: > > On 07/18/2014 11:22 AM, Kaushal M wrote: >> >> On Fri, Jul 18, 2014 at 11:11 AM, Pranith Kumar Karampuri >> wrote: >>> >>> On 07/17/2014 07:25 PM, Kaushal M wrote: I came across mediawiki's developer documentation and

Re: [Gluster-devel] Inspiration for improving our contributor documentation

2014-07-17 Thread Pranith Kumar Karampuri
On 07/18/2014 11:22 AM, Kaushal M wrote: On Fri, Jul 18, 2014 at 11:11 AM, Pranith Kumar Karampuri wrote: On 07/17/2014 07:25 PM, Kaushal M wrote: I came across mediawiki's developer documentation and guides when browsing. These docs felt really good to me, and easy to approach. I feel that w

Re: [Gluster-devel] Inspiration for improving our contributor documentation

2014-07-17 Thread Kaushal M
On Fri, Jul 18, 2014 at 11:11 AM, Pranith Kumar Karampuri wrote: > > On 07/17/2014 07:25 PM, Kaushal M wrote: >> >> I came across mediawiki's developer documentation and guides when >> browsing. These docs felt really good to me, and easy to approach. >> I feel that we should take inspiration from

Re: [Gluster-devel] Inspiration for improving our contributor documentation

2014-07-17 Thread Pranith Kumar Karampuri
On 07/17/2014 07:25 PM, Kaushal M wrote: I came across mediawiki's developer documentation and guides when browsing. These docs felt really good to me, and easy to approach. I feel that we should take inspiration from them and start enhancing our docs. (Outright copying with modifications as nec

[Gluster-devel] Inspiration for improving our contributor documentation

2014-07-17 Thread Kaushal M
I came across mediawiki's developer documentation and guides when browsing. These docs felt really good to me, and easy to approach. I feel that we should take inspiration from them and start enhancing our docs. (Outright copying with modifications as necessary, could work too. But that just doesn'