summaryrefslogtreecommitdiffstats
path: root/doc/developer-guide/README.md
diff options
context:
space:
mode:
authorAmar Tumballi <amarts@redhat.com>2018-09-11 16:09:55 +0530
committerAmar Tumballi <amarts@redhat.com>2018-09-12 09:28:49 +0000
commitbc4201b4c23eee0e3d09a6760b449a0011677cd5 (patch)
tree544fcf4f23b8e25fac65b35fcf81d41bc0d845bf /doc/developer-guide/README.md
parent65db3e596e456e11f524160261bf87a9ebe9fa00 (diff)
doc: make developer-index.md as README
This helps to traverse the docs well as README.md is rendered by default in github pages, and would help to provide better indexed document for new users. updates: bz#1193929 Change-Id: I4130dfd16aed924ecab17f96326cedb86892d6a6 Signed-off-by: Amar Tumballi <amarts@redhat.com>
Diffstat (limited to 'doc/developer-guide/README.md')
-rw-r--r--doc/developer-guide/README.md74
1 files changed, 74 insertions, 0 deletions
diff --git a/doc/developer-guide/README.md b/doc/developer-guide/README.md
new file mode 100644
index 00000000000..4c6346e83d4
--- /dev/null
+++ b/doc/developer-guide/README.md
@@ -0,0 +1,74 @@
+Developers
+==========
+
+### From GlusterDocumentation
+
+Contributing to the Gluster community
+-------------------------------------
+
+Are you itching to send in patches and participate as a developer in the
+Gluster community? Here are a number of starting points for getting
+involved. We don't require a signed contributor license agreement or
+copyright assignment, but we do require a "signed-off-by" line on each
+code check-in.
+
+- [License
+ Change](http://www.gluster.org/2012/05/glusterfs-license-change/) -
+ we recently changed the client library code to a dual license under
+ the GPL v2 and the LGPL v3 or later
+- [GlusterFS Coding Standards](./coding-standard.md)
+
+Developing
+----------
+
+- [Language Bindings](./Language Bindings.md) - Connect to
+ GlusterFS using various language bindings
+
+Adding File operations
+----------------------
+
+- [Steps to be followed when adding a new FOP to GlusterFS ](./adding-fops.md)
+
+Automatic File Replication
+--------------------------
+
+- [Cluster/afr translator](./afr.md)
+- [History of Locking in AFR](./afr-locks-evolution.md)
+- [Self heal Daemon](./afr-self-heal-daemon.md)
+
+Data Structures
+---------------
+
+- [inode data structure](./datastructure-inode.md)
+- [iobuf data structure](./datastructure-iobuf.md)
+- [mem-pool data structure](./datastructure-mem-pool.md)
+
+Find the gfapi symbol versions [here](./gfapi-symbol-versions.md)
+
+Daemon Management Framework
+---------------------------
+
+- [How to introduce new daemons using daemon management framework](./daemon-management-framework.md)
+
+Translators
+-----------
+
+- [Block Device Tanslator](./bd-xlator.md)
+- [Performance/write-Behind Translator](./write-behind.md)
+- [Translator Development](./translator-development.md)
+- [Storage/posix Translator](./posix.md)
+- [Compression translator](./network_compression.md)
+
+Testing/Debugging
+-----------------
+
+- [Unit Tests in GlusterFS](./unittest.md)
+- [Using the Gluster Test
+ Framework](./Using Gluster Test Framework.md) - Step by
+ step instructions for running the Gluster Test Framework
+- [Coredump Analysis](./coredump-analysis.md) - Steps to analize coredumps generated by regression machines.
+- [Identifying Resource Leaks](./identifying-resource-leaks.md)
+
+Release Process
+---------------
+- [Versioning](./versioning.md)