summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorHumble Devassy Chirammal <hchiramm@redhat.com>2015-07-24 11:33:57 +0530
committerKaleb KEITHLEY <kkeithle@redhat.com>2015-07-26 03:26:57 -0700
commite9b86d0b575e8e59f0910874341a4a05574124cf (patch)
tree2f27e00420966bcb00c87d738709c9cbbe319e01 /doc
parentbf8e604e35ff5aafd15dd235bf2b565e8cd65ea5 (diff)
Adding README for gluster documentation project
Change-Id: I1bcfc14ee3eabeb26a5cea42533c8df5b040f549 BUG: 1206539 Signed-off-by: Humble Devassy Chirammal <hchiramm@redhat.com> Reviewed-on: http://review.gluster.org/11753 Tested-by: NetBSD Build System <jenkins@build.gluster.org> Tested-by: Gluster Build System <jenkins@build.gluster.com> Reviewed-by: Kaleb KEITHLEY <kkeithle@redhat.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/README.md b/doc/README.md
new file mode 100644
index 00000000000..e057437fcba
--- /dev/null
+++ b/doc/README.md
@@ -0,0 +1,18 @@
+## 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 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://gluster.readthedocs.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)