From 7b07c6542ff80ef962bf67c603ce6084224f4b3f Mon Sep 17 00:00:00 2001 From: Prashanth Pai Date: Thu, 19 Jul 2018 12:18:25 +0530 Subject: [PATCH] doc: Add index to documentation Signed-off-by: Prashanth Pai --- README.md | 6 ++---- doc/index.md | 15 +++++++++++++++ 2 files changed, 17 insertions(+), 4 deletions(-) create mode 100644 doc/index.md diff --git a/README.md b/README.md index 9931f63d..05bf8680 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,8 @@ GlusterD, while also becoming more modular and easing extensibility. ## Documentation -* [Quick Start User Guide](doc/quick-start-user-guide.md) -* [Development Guide](doc/development-guide.md) -* [Coding Guidelines](doc/coding.md) -* [REST API Reference](doc/endpoints.md) +* [User documentation](doc/index.md#user-documentation) +* [Developer documentation](doc/index.md#developer-documentation) ## Architecture and Design Please refer to the [wiki](https://github.com/gluster/glusterd2/wiki/Design) for more information. diff --git a/doc/index.md b/doc/index.md new file mode 100644 index 00000000..b1a0c3b5 --- /dev/null +++ b/doc/index.md @@ -0,0 +1,15 @@ +# Glusterd2 Documentation + +## User Documentation + +* [Quick Start Guide](quick-start-user-guide.md) +* [REST API Reference](doc/endpoints.md) +* [Network and firewall configuration](network.md) + +## Developer Documentation + +* [Development Guide](development-guide.md) +* [Testing](testing.md) +* [Coding convention](coding.md) +* [Supervisor trees](supervisor-trees.md) +* [Translators and volfiles](xlator.md)