glusterfs/doc/README.md
Amar Tumballi 763eb83dcb doc: add coding-standard and commit-msg link in README
Having the links in README makes people follow it if they browse
through github.

Updates: bz#1193929
Change-Id: I580332a41d9b52858aa9796a74a563ff57a60b4b
Signed-off-by: Amar Tumballi <amarts@redhat.com>
2018-09-11 22:55:23 +00:00

1.3 KiB

Developer Guide

Gluster's contributors can check about the internals by visiting Developer Guide Section. While it is not 'comprehensive', it can help you to get started.

Also while coding, keep Coding Standard in mind.

When you are ready to commit the changes, make sure you meet our Commit message standard.

Admin Guide

The gluster administration guide is maintained at github. The browsable admin guide can be found here.

The doc patch has to be sent against the above mentioned repository.

Features/Spec

The Gluster features which are 'in progress' or implemented can be found at github.

Upgrade Guide

The gluster upgrade guide is maintained at github. The browsable upgrade guide can be found here

The doc patch has to be sent against the above mentioned repository.

For more details about the docuemntation workflow please refer this discussion