[Gluster-infra] Documentation page concerns.

[Soumya Deb]

With Humble's help, I discovered that the updated docss live in markdown
format in the source itself.

For e.g. https://github.com/gluster/glusterfs/tree/master/doc/admin-guide/en-US/markdown

It may be worth looking into, using RawGit.com (as the source lives on GH)
displaying the same in-source docs on the website.

E.g. http://rawgit.com/gluster/glusterfs/master/doc/admin-guide/en-US/markdown/admin_geo-replication.md
serves over HTTP a properly MIME-typed web-usable markdown-text version of
https://github.com/gluster/glusterfs/blob/master/doc/admin-guide/en-US/markdown/admin_geo-replication.md

i.e. to explain:
0. replace "http://rawgit.com" instead of "https://github.com"
1. remove "/blob"
2. profit!

Now, all one needs on the website's end, is a markdown-parser in JS and
pass the markdown content to be rendered as HTML & put in the DOM.

Ref: https://github.com/evilstreak/markdown-js

Agreed, that we should revisit the entire website, but it may help fixing
the docs, now. Broken docs, even for a day, isn't nice. :( :P

Hope it helps.


On 11/18/2014 11:22 PM, Dave McAllister wrote:
> We need to revisit the entire site. I'm going to have a patch for the
> home page soon, and I've aske da documentation specialist to look over
> the doc issues.
> 
> I think actively convening a website issues and actions meeting for the
> community is in order
> 
> davemc
> 
> 
> On 11/18/2014 02:42 AM, Humble Chirammal wrote:
> > Hi All,
> >
> > The "Administrator Guide" at http://gluster.org/documentation/ directly
> > refer to the github GlusterFS source doc, which is less userfriendly. It
> > would be nice to have a have a more indexed, easily readable page for
> > GlusterFS something similar as Openstack - http://docs.openstack.org/
> >
> >
> > Also I noticed "Development HowTo's" & "Fixing issues reported by tools for
> > static code analysis" in "Developer" title are broken links:
> >
> >
> > http://gluster.org/documentation/developers/howto/Developer_HowTo
> >
> > http://gluster.org/developers/Fixing_Issues_Reported_By_Tools_For_Static_Code_Analysis
> >
> >
> > Any thoughts here ?
> >
> > Cheers,
> > Humble
> >
> > Senior Software  Engineer
> > RH India
> >
> >
> > _______________________________________________
> > Gluster-infra mailing list
> > Gluster-infra at gluster.org
> > http://www.gluster.org/mailman/listinfo/gluster-infra
> 
> _______________________________________________
> Gluster-infra mailing list
> Gluster-infra at gluster.org
> http://www.gluster.org/mailman/listinfo/gluster-infra
>