diff options
author | Humble Devassy Chirammal <hchiramm@redhat.com> | 2015-09-24 14:53:52 +0530 |
---|---|---|
committer | Humble Devassy Chirammal <humble.devassy@gmail.com> | 2015-10-10 05:49:01 -0700 |
commit | a4f982be9b21323038704069a56fb2448369d6a0 (patch) | |
tree | 1daf99ef973b95b004938bb0e76b544907180b84 /doc/developer-guide/Developers-Index.md | |
parent | bad9539437ca1d69e470159277bbb6b5675cbae3 (diff) |
Porting developer guide to source code repo from glusterdocs project
Change-Id: Ib8d9c668ebb05863918e6ec2b89908f206626f38
BUG: 1206539
Signed-off-by: Humble Devassy Chirammal <hchiramm@redhat.com>
Reviewed-on: http://review.gluster.org/12227
Tested-by: NetBSD Build System <jenkins@build.gluster.org>
Reviewed-by: Prashanth Pai <ppai@redhat.com>
Reviewed-by: Humble Devassy Chirammal <humble.devassy@gmail.com>
Tested-by: Humble Devassy Chirammal <humble.devassy@gmail.com>
Tested-by: Raghavendra Talur <rtalur@redhat.com>
Diffstat (limited to 'doc/developer-guide/Developers-Index.md')
-rw-r--r-- | doc/developer-guide/Developers-Index.md | 127 |
1 files changed, 127 insertions, 0 deletions
diff --git a/doc/developer-guide/Developers-Index.md b/doc/developer-guide/Developers-Index.md new file mode 100644 index 00000000000..a523a4681c9 --- /dev/null +++ b/doc/developer-guide/Developers-Index.md @@ -0,0 +1,127 @@ +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. + +- [Simplified Developer Workflow](./Simplified Development Workflow.md) + - A simpler and faster intro to developing with GlusterFS, than the + doc below. +- [Developer Workflow](./Development Workflow.md) - this tells + you about our patch requirements, tools we use, and more. Required + reading if you want to contribute code. +- [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) + +Compiling Gluster +----------------- + +- [Compiling RPMS](./Compiling RPMS.md) - Step by step + instructions for compiling Gluster RPMS +- [Building GlusterFS](./Building GlusterFS.md) - How to compile + Gluster from source code. Including instructions for Ubuntu. + +Developing +---------- + +- [Projects](./Projects.md) - Ideas for projects you could + create +- [Language Bindings](./Language Bindings.md) - Connect to + GlusterFS using various language bindings +- [EasyFix\_Bugs](./Easy Fix Bugs.md) - Easy to fix bugs of + GlusterFS. One of the best place to start contributing to GlusterFS. +- [Fixing issues reported by tools for static code + analysis](./Fixing issues reported by tools for static code analysis.md) + - This is a good starting point for developers to fix bugs in + GlusterFS project. +- [Backport Wishlist](./Backport Wishlist.md) - Problems fixed + in the master branch might need to get fixed in stable release + branches too. + The [Backport Guidelines](./Backport Guidelines.md) describe the steps that + branches too. + +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 +- [Our Jenkins Infrastructure](./Jenkins Infrastructure.md) - A + braindump of the Jenkins infrastructure we have in place for + automated testing +- [Manual steps for setting up a Jenkins slave VM in + Rackspace](./Jenkins Manual Setup.md) - Steps for setting up a slave + VM in Rackspace +- [Coredump Analysis](./coredump-analysis.md) - Steps to analize coredumps generated by regression machines. + +Bug Handling +------------ + +- [Bug reporting guidelines](./Bug Reporting Guidelines.md) - + Guideline for reporting a bug in GlusterFS +- [Bug triage guidelines](./Bug Triage.md) - Guideline on how to + triage bugs for GlusterFS +- [Bug report life cycle in + Bugzilla](./Bug report Life Cycle.md) - Information about bug + life cycle + +Patch Acceptance +---------------- + +- The [Guidelines For + Maintainers](./Guidelines For Maintainers.md) explains when + maintainers can merge patches. + +Release Process +--------------- + +- [Versioning](./versioning.md) +- [GlusterFS Release Process](./GlusterFS Release process.md) - + Our release process / checklist |