From: Stephen Finucane <stephen@that.guru>
Date: Thu, 2 Nov 2017 16:05:28 +0000 (+0000)
Subject: docs: Add index pages
X-Git-Tag: v2.1.0-rc1~111
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=018560c49a97b891f160f5c186b96e0cad5172e6;p=thirdparty%2Fpatchwork.git

docs: Add index pages

This lets me go to, for example, the following URLs:

  https://patchwork.readthedocs.io/en/latest/releases/

Signed-off-by: Stephen Finucane <stephen@that.guru>
---

diff --git a/docs/api/index.rst b/docs/api/index.rst
new file mode 100644
index 00000000..b2e93e01
--- /dev/null
+++ b/docs/api/index.rst
@@ -0,0 +1,12 @@
+API Documentation
+=================
+
+Patchwork provides two APIs: a REST API and a legacy XML-RPC API. The REST API
+is recommended as the XML-RPC API is deprecated and will be removed in a future
+release.
+
+.. toctree::
+   :maxdepth: 2
+
+   /api/rest
+   /api/xmlrpc
diff --git a/docs/deployment/index.rst b/docs/deployment/index.rst
new file mode 100644
index 00000000..d7b3fa37
--- /dev/null
+++ b/docs/deployment/index.rst
@@ -0,0 +1,14 @@
+Deployment Documentation
+========================
+
+Patchwork is a pretty standard Django application and is in widespread
+production use across the web. The below documents provide information on how
+you could deploy your own Patchwork instances for production use.
+
+.. toctree::
+   :maxdepth: 2
+
+   /deployment/installation
+   /deployment/configuration
+   /deployment/management
+   /deployment/upgrading
diff --git a/docs/development/index.rst b/docs/development/index.rst
new file mode 100644
index 00000000..4447453c
--- /dev/null
+++ b/docs/development/index.rst
@@ -0,0 +1,15 @@
+Development Documention
+=======================
+
+Patchwork provides a number of tools to help ease getting an instance up and
+running. Information on these tools, along with general contribution advice and
+developer-focussed usage information, is provided in the below docs.
+
+.. toctree::
+   :maxdepth: 2
+
+   /development/contributing
+   /development/installation
+   /development/releasing
+   /development/api
+   /development/assets
diff --git a/docs/index.rst b/docs/index.rst
index e0f75d5c..2c2b92d4 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -21,7 +21,7 @@ of community projects.
 
 .. toctree::
    :maxdepth: 2
-   :caption: User Documentation
+   :caption: Usage Documentation
 
    usage/overview
    usage/design
@@ -72,3 +72,12 @@ of community projects.
    releases/cashmere
    releases/burlap
    releases/alpaca
+
+.. toctree::
+   :hidden:
+
+   usage/index
+   deployment/index
+   development/index
+   api/index
+   releases/index
diff --git a/docs/releases/index.rst b/docs/releases/index.rst
new file mode 100644
index 00000000..f0d60637
--- /dev/null
+++ b/docs/releases/index.rst
@@ -0,0 +1,14 @@
+Releases
+========
+
+Release notes for each Patchwork releases are provided below. For information
+on the release process, refer to :doc:`/development/releasing`.
+
+.. toctree::
+   :maxdepth: 2
+
+   /releases/unreleased
+   /releases/dazzle
+   /releases/cashmere
+   /releases/burlap
+   /releases/alpaca
diff --git a/docs/usage/index.rst b/docs/usage/index.rst
new file mode 100644
index 00000000..79d10d83
--- /dev/null
+++ b/docs/usage/index.rst
@@ -0,0 +1,17 @@
+Usage Documentation
+===================
+
+Patchwork provides features designed to help all users of development mailing
+lists, from those simply trying to get information about a patch to maintainers
+wanting to keep track of the status of the hundreds of in-flight patches. The
+below guides provide both general information on the design of Patchwork along
+with overviews of specific features.
+
+.. toctree::
+   :maxdepth: 2
+
+   /usage/overview
+   /usage/design
+   /usage/delegation
+   /usage/headers
+   /usage/clients