diff options
Diffstat (limited to 'doc/README.md')
| -rw-r--r-- | doc/README.md | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/doc/README.md b/doc/README.md index e057437fcba..6aa28642ef4 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,6 +1,14 @@ +## 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://gluster.readthedocs.org/en/latest/Administrator%20Guide/README/). +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. @@ -10,7 +18,7 @@ The Gluster features which are 'in progress' or implemented can be found at [git ## Upgrade Guide ## -The gluster upgrade guide is maintained at [github](https://github.com/gluster/glusterdocs). The browsable upgrade guide can be found [here](http://gluster.readthedocs.org/en/latest/Upgrade-Guide/README/) +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) The doc patch has to be sent against the above mentioned repository. |