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

27 lines
1.3 KiB
Markdown

## Developer Guide
Gluster's contributors can check about the internals by visiting [Developer Guide Section](developer-guide). While it is not 'comprehensive', it can help you to get started.
Also while coding, keep [Coding Standard](developer-guide/coding-standard.md) in mind.
When you are ready to commit the changes, make sure you meet our [Commit message standard](developer-guide/commit-guidelines.md).
## Admin Guide ##
The gluster administration guide is maintained at [github](https://github.com/gluster/glusterdocs). The browsable admin guide can be found [here](http://docs.gluster.org/en/latest/Administrator%20Guide/).
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](https://github.com/gluster/glusterfs-specs).
## Upgrade Guide ##
The gluster upgrade guide is maintained at [github](https://github.com/gluster/glusterdocs). The browsable upgrade guide can be found [here](http://docs.gluster.org/en/latest/Upgrade-Guide/README/)
The doc patch has to be sent against the above mentioned repository.
For more details about the docuemntation workflow please refer [this discussion](https://www.mail-archive.com/gluster-users@gluster.org/msg21168.html)