On 03/17/2015 09:30 PM, Joe Julian wrote:
On 03/17/2015 06:47 AM, Glenn Holmer wrote:
On 03/17/2015 01:43 AM, Joe Julian wrote:
I'll split this out as I think you're unaware of the admin guide that's
pretty detailed and is, at least, published with the source code (it may
be on the gluster.org site somewhere, but I'm too tired right now to
look). The source can readily be found on github
<https://github.com/GlusterFS/glusterfs/tree/master/doc/admin-guide/en-US/markdown>.
As good as that guide is, I see that as an issue. The documentation page
has an "Administrator Guide" link that goes to... the markdown source on
github (same link you posted). Couldn't a PDF be built from that in CI
and linked to from the documentation page? It would be a lot easier to
use (and give a better impression than "here, look at the source").
Probably. Personally, I abhor pdf and wish it would die a fiery death.
If I had my preference, the md would just be rendered into an html guide.
FWIW, I was able to render a rudimentary single page html guide by
issuing the following command line:
pandoc -t html -o gluster_admin_guide.html glusterfs_introduction.md
admin_start_stop_daemon.md admin_console.md admin_storage_pools.md
admin_setting_volumes.md admin_managing_volumes.md
admin_settingup_clients.md admin_monitoring_workload.md
admin_directory_Quota.md admin_distributed_geo_rep.md
admin_object_storage.md admin_managing_snapshots.md admin_ssl.md
admin_troubleshooting.md did-you-know.md glossary.md
The result is available at [1]. This does not include all .md files, has
some issues in rendering a few images and the documentation flow is not
the best, but it possibly seems much better than whatever we have right
now.
I don't think it would be too complex to evolve a jenkins job based on
the above command line. Would somebody in gluster-infra with access to
gluster.org and our jenkins installation be able to configure a daily
job that does this conversion and roll it out on gluster.org?
Once we have this setup we can roll out various formats on to gluster.org.
-Vijay
[1]
http://employees.org/~vbellur/glusterfs/admin-guide/20150317/gluster_admin_guide.html
_______________________________________________
Gluster-users mailing list
Gluster-users@xxxxxxxxxxx
http://www.gluster.org/mailman/listinfo/gluster-users
