summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLuis Pabon <lpabon@redhat.com>2013-06-26 15:19:16 -0400
committerPeter Portante <pportant@redhat.com>2013-06-28 12:37:55 -0700
commit92fdc68d6b90f4f7327bdffe542c5e8807a3e6c5 (patch)
tree1ff0eafb7f730706fb4182c1893a39318beffd90 /README.md
parentcc97abca0482d3023c9d2fa9d0028098d08e818b (diff)
Initial community documentation
Community documentation is being written in Markdown format because we can leverage GitHub.com's ability to render Markdown into HTML directly from files in the repo. Also, the GlusterFS Community project has decided to use Markdown as an input into the tool called pandoc which can convert the documents into multiple formats. Change-Id: Iec530f05a9a1ab3a95a1e97b791e8390068b99b4 Signed-off-by: Luis Pabon <lpabon@redhat.com> Reviewed-on: http://review.gluster.org/5256 Reviewed-by: Peter Portante <pportant@redhat.com> Tested-by: Peter Portante <pportant@redhat.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..236bbd7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# Gluster For Swift
+Integrating GlusterFS as the back-end to OpenStack Swift
+implementation. This is a component of the Unified File and Object (UFO)
+story for GlusterFS, which allows files and directories created via
+gluster-native/nfs/samba mount(s) to be accessed as objects via
+the Swift API.
+
+# Table of Contents
+1. [Overview and Concepts](doc/markdown/concepts.md)
+1. [Usage Guide](doc/markdown/user_guide.md)
+1. [Developer Guide](doc/markdown/dev_guide.md)
+