Update documentation and add a index

If one wanted to read all the documentation in the Gitaly repository the
best way to do so was opening the doc directory. Structure was missing.
This commit updates the documentation and adds an index page.

1 files changed, 23 insertions, 0 deletions

diff --git a/doc/README.md b/doc/README.md
new file mode 100644
index 000000000..8a56249f0
--- /dev/null
+++ b/doc/README.md
@@ -0,0 +1,23 @@
+## Gitaly documentation
+
+The historical reasons for the inception of Gitaly and our design decisions are
+written in [the design doc](doc/DESIGN.md).
+
+#### Configuring Gitaly
+
+Running Gitaly requires it to be configured correctly, options are described in
+the [configuration documentation](doc/configuration/README.md).
+
+#### Developing Gitaly
+
+- When new to Gitaly development, start by reading the [beginners guide](docs/beginners_guid.md).
+- When developing on Gitaly-Ruby, read the [Gitaly-Ruby doc](doc/ruby_endpoint.md)
+- The Gitaly release process is descripted in [our process doc](doc/PROCESS.md)
+- Tests use Git repositories too, [read more about them](doc/test_repos.md)
+
+#### Gitaly HA
+
+Gitaly does not replicate any data. If a Gitaly server goes down, any of its
+clients can't read or write to the repositories stored on that server. This
+means that Gitaly is not highly available. How this will be solved is described
+[in the HA design document](doc/design_ha.md)