diff options
| author | Sunil Kumar Acharya <sheggodu@redhat.com> | 2017-06-15 11:39:56 +0530 |
|---|---|---|
| committer | Shyamsundar Ranganathan <srangana@redhat.com> | 2017-06-21 10:46:17 +0000 |
| commit | b2522297dd1e8b444a75b9cf177b2e6f6dffa05e (patch) | |
| tree | c874c76902ec1abd0e54bef6f9af7fb488dbae67 /README.md | |
| parent | b224f4253b7d3de3077ee35c8bdc20618eae4b7c (diff) | |
doc: Update GlusterFS README
Reorganizing GlusterFS README contents.
BUG: 1461648
Change-Id: I3696e41963c536679d04934930d491f425ffe1ad
Signed-off-by: Sunil Kumar Acharya <sheggodu@redhat.com>
Reviewed-on: https://review.gluster.org/17550
Smoke: Gluster Build System <jenkins@build.gluster.org>
Reviewed-by: Amar Tumballi <amarts@redhat.com>
Reviewed-by: Pranith Kumar Karampuri <pkarampu@redhat.com>
CentOS-regression: Gluster Build System <jenkins@build.gluster.org>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 17 insertions, 5 deletions
diff --git a/README.md b/README.md index 2dd268ef87d..1cab5c19390 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,21 @@ -For information about contributing to GlusterFS, please follow [Contributing to GlusterFS community](https://gluster.readthedocs.io/en/latest/Developer-guide/Developers-Index/#contributing-to-the-gluster-community). +# Gluster + Gluster is a software defined distributed storage that can scale to several + petabytes. It provides interfaces for object, block and file storage. -*GlusterFS does not follow the [GitHub: Fork & pull](https://help.github.com/articles/using-pull-requests/) workflow but use [Gerrit](http://review.gluster.org) for code review.* +## Development + Contributions to gluster in the form of patches and new feature additions can + be made by following steps outlined at [Developers Guide](https://gluster.readthedocs.io/en/latest/Developer-guide/Developers-Index/#contributing-to-the-gluster-community). -The development guidelines are detailed in [Development Workflow](https://gluster.readthedocs.io/en/latest/Developer-guide/Simplified-Development-Workflow). +## Documentation + The Gluster documentation can be found at [Gluster Docs](http://gluster.readthedocs.io/en/latest). -The GlusterFS documentation can be found at [our Read the Docs site](http://gluster.readthedocs.io/en/latest). +## Deployment + Quick instructions to build and install can be found in [INSTALL](INSTALL) file. -For more info, please visit [gluster.org](http://www.gluster.org/). +## Maintainers + The list of Gluster maintainers is available in [MAINTAINERS](MAINTAINERS) file. + +## License + Gluster is dual licensed under [GPLV2](COPYING-GPLV2) and [LGPLV3+](COPYING-LGPLV3). + + Please visit the [Gluster Home Page](http://www.gluster.org/) to find out more about Gluster. |