mirror of
https://github.com/gluster/glusterdocs.git
synced 2026-02-05 15:47:01 +01:00
Added Contributors-Guide
* Renamed Workflow-Guide to Contributors-Guide * Updated Index.md Updated Developer-guide * Update Developers-Index.md * Added file Easy-Fix-Bugs.md from "https://github.com/gluster/glusterfs/tree/master/doc/developer-guide" Updated mkdocs.yml to reflect changes. Signed-off-by: Bipin Kunal <bkunal@redhat.com>
This commit is contained in:
Bipin Kunal
29
Contributors-Guide/Index.md
Normal file
29
Contributors-Guide/Index.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# Workflow Guide
|
||||
|
||||
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
|
||||
- [Bug Reporting Template](./Bug-reporting-template.md) -
|
||||
Information about how a bug should be reported in Bugzilla.
|
||||
|
||||
Release Process
|
||||
---------------
|
||||
|
||||
- [GlusterFS Release process](./GlusterFS-Release-process.md) -
|
||||
Our release process / checklist
|
||||
|
||||
Patch Acceptance
|
||||
----------------
|
||||
|
||||
- The [Guidelines For
|
||||
Maintainers](./Guidelines-For-Maintainers.md) explains when
|
||||
maintainers can merge patches.
|
||||
|
||||
|
||||
@@ -4,24 +4,55 @@ Developers
|
||||
### Contributing to the Gluster community
|
||||
-------------------------------------
|
||||
|
||||
1. Development Workflow
|
||||
* [Simplified Development Workflow](./Simplified-Development-Workflow.md)
|
||||
* [Development-Workflow](./Development-Workflow.md)
|
||||
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.
|
||||
|
||||
2. Building Glusterfs
|
||||
* [Build and Install GlusterFS](./Building-GlusterFS.md)
|
||||
* [Compiling RPMS from GIT Source](./Compiling-RPMS.md)
|
||||
Workflow
|
||||
--------
|
||||
|
||||
3. Backport
|
||||
* [Backport Guidelines](./Backport-Guidelines.md)
|
||||
* [Backport Wishlist](./Backport-Wishlist.md)
|
||||
- [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.
|
||||
|
||||
4. Jenkins
|
||||
* [Jenkins Infrastructure](./Jenkins-Infrastructure.md)
|
||||
* [Jenkins Manual Setup][./Jenkins-Manual-Setup.md)
|
||||
Compiling Gluster
|
||||
-----------------
|
||||
|
||||
5. [Fixing issues reported by tools for static code analysis](./Fixing-issues-reported-by-tools-for-static-code-analysis.md)
|
||||
- [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.
|
||||
|
||||
6. [Project Ideas](./Projects.md)
|
||||
Developing
|
||||
----------
|
||||
|
||||
- [Projects](./Projects.md) - Ideas for projects you could
|
||||
create
|
||||
- [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.
|
||||
- [Backport Guidelines](./Backport-Guidelines.md) describe the steps that
|
||||
branches too.
|
||||
|
||||
Testing
|
||||
-------
|
||||
|
||||
- [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
|
||||
|
||||
Other Gluster Developer documentation can be found [here](https://github.com/gluster/glusterfs/tree/master/doc/developer-guide)
|
||||
|
||||
35
Developer-guide/Easy-Fix-Bugs.md
Normal file
35
Developer-guide/Easy-Fix-Bugs.md
Normal file
@@ -0,0 +1,35 @@
|
||||
Fixing easy bugs is an excellent method to start contributing patches to
|
||||
Gluster.
|
||||
|
||||
- Bugs which are marked with EasyFix flag can be found from below
|
||||
BugZilla query.
|
||||
- [Bugzilla Query For EasyFix
|
||||
Bugs](https://bugzilla.redhat.com/buglist.cgi?bug_status=NEW&keywords=EasyFix&list_id=2626252&product=GlusterFS)
|
||||
- [RSS-feed for EasyFix Gluster Bugs](http://goo.gl/OpQwlv)
|
||||
- To fix EasyFix bugs,
|
||||
- When you pick an EasyFix you want to work on, assign it to
|
||||
yourself and move it to ASSIGNED
|
||||
- Check
|
||||
[Bug report life cycle](./Bug report Life Cycle.md) and
|
||||
follow it.
|
||||
- Check Developers page for details about development workflow,
|
||||
GlusterFS design documents etc.
|
||||
|
||||
Sometimes an *Easy Fix* bug has a patch attached. In those cases,
|
||||
the *Patch* keyword has been added to the bug. These bugs can be
|
||||
used by new contributors that would like to verify their workflow. [Bug
|
||||
1099645](https://bugzilla.redhat.com/1099645) is one example of those.
|
||||
|
||||
### Guidelines for new comers
|
||||
|
||||
- While trying to write a patch, do not hesitate to ask questions.
|
||||
- If something in the documentation is unclear, we do need to know so
|
||||
that we can improve it.
|
||||
- There are no stupid questions, and it's more stupid to not ask
|
||||
questions that others can easily answer. Always assume that if you
|
||||
have a question, someone else would like to hear the answer too.
|
||||
|
||||
[Reach out](http://gluster.org/community/index.html) to the developers
|
||||
in \#gluster or \#gluster-dev on Freenode IRC, or on one of the mailing
|
||||
lists, try to keep the discussions public so that anyone can learn from
|
||||
it.
|
||||
@@ -1,12 +0,0 @@
|
||||
# Workflow Guide
|
||||
|
||||
1. Bug Guidelines
|
||||
|
||||
* [Bug Reporting Guidelines](./Bug-Reporting-Guidelines.md)
|
||||
* [Bug Reporting Template](./Bug-reporting-template.md)
|
||||
* [Bug report Cycle](./Bug-report-Life-Cycle.md)
|
||||
* [Bug Triage](./Bug-Triage.md)
|
||||
|
||||
2. [GlusterFS Release process](./GlusterFS-Release-process.md)
|
||||
|
||||
3. [Guidelines For Maintainers](./Guidelines-For-Maintainers.md)
|
||||
25
mkdocs.yml
25
mkdocs.yml
@@ -64,22 +64,23 @@ pages:
|
||||
- Developers Home: Developer-guide/Developers-Index.md
|
||||
- Simplified Development Workflow : Developer-guide/Simplified-Development-Workflow.md
|
||||
- Development-Workflow : Developer-guide/Development-Workflow.md
|
||||
- Build and Install GlusterFS : Developer-guide/Building-GlusterFS.md
|
||||
- Compiling RPMS from GIT Source : Developer-guide/Compiling-RPMS.md
|
||||
- Backport Guidelines : Developer-guide/Backport-Guidelines.md
|
||||
- Build and Install GlusterFS : Developer-guide/Building-GlusterFS.md
|
||||
- Project Ideas : Developer-guide/Projects.md
|
||||
- [EasyFix bugs] : Developer-guide/Easy-Fix-Bugs.md
|
||||
- Fixing issues reported by tools for static code analysis : Developer-guide/Fixing-issues-reported-by-tools-for-static-code-analysis.md)
|
||||
- Backport Wishlist : Developer-guide/Backport-Wishlist.md)
|
||||
- Backport Guidelines : Developer-guide/Backport-Guidelines.md
|
||||
- Jenkins Infrastructure : Developer-guide/Jenkins-Infrastructure.md
|
||||
- Jenkins Manual Setup : Developer-guide/Jenkins-Manual-Setup.md
|
||||
- Fixing issues reported by tools for static code analysis : Developer-guide/Fixing-issues-reported-by-tools-for-static-code-analysis.md)
|
||||
- Project Ideas : Developer-guide/Projects.md
|
||||
- Workflow-Guide:
|
||||
- Index: Workflow-Guide/Index.md
|
||||
- Bug Reporting Guidelines : Workflow-Guide/Bug-Reporting-Guidelines.md
|
||||
- Bug Reporting Template : Workflow-Guide/Bug-reporting-template.md
|
||||
- Bug report Cycle : Workflow-Guide/Bug-report-Life-Cycle.md
|
||||
- Bug Triage : Workflow-Guide/Bug-Triage.md
|
||||
- GlusterFS Release process : Workflow-Guide/GlusterFS-Release-process.md
|
||||
- Guidelines For Maintainers : Workflow-Guide/Guidelines-For-Maintainers.md
|
||||
- Contributors Guide:
|
||||
- Index: Contributors-Guide/Index.md
|
||||
- Bug Reporting Guidelines : Contributors-Guide/Bug-Reporting-Guidelines.md
|
||||
- Bug Triage : Contributors-Guide/Bug-Triage.md
|
||||
- Bug report Cycle : Contributors-Guide/Bug-report-Life-Cycle.md
|
||||
- Bug Reporting Template : Contributors-Guide/Bug-reporting-template.md
|
||||
- GlusterFS Release process : Contributors-Guide/GlusterFS-Release-process.md
|
||||
- Guidelines For Maintainers : Contributors-Guide/Guidelines-For-Maintainers.md
|
||||
- Upgrade-Guide:
|
||||
- Upgrade-Guide Index: Upgrade-Guide/README.md
|
||||
- Upgrade to 3.5: Upgrade-Guide/upgrade_to_3.5.md
|
||||
|
||||
Reference in New Issue
Block a user