# HG changeset patch
# User Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
# Date 1526498440 -7200
# Node ID e71216a16853e9b5987fcb9419ad43db7efca56e
# Parent  eddb927e34730485e7f6b6f5be9d1092af25f217
docs: reorganize index page

Reorganize the index page of the manual into three main sections:
administrator guide, user guide, developer guide. In principle,
administrators, users and developers are independent roles that can be
fulfilled by different people.

'Administrators' install, configure and maintain Kallithea. They have
'admin' privilege in the web interface.

'Users' do not have access to the Kallithea installation files. They can
only access the web interface, and generally do not have 'admin' privilege.
They may be the owner of repositories, repository groups, or user groups,
and as such modify the settings of these objects, even though they cannot
modify the settings of Kallithea itself.

'Developers' modify the Kallithea source code. They may or may not
contribute these changes back to the Kallithea community.



The 'Readme' section is a bit outside of this classification. As it serves
as a basic introduction to Kallithea, it is kept first.

The 'Index' and 'Search' functionality are not really 'part of' the manual,
so should not be under 'Other topics'. Instead they are put at the very top
so they are readily visible.


This commit is only changing the index page. Subsequent commits can move and
split some documentation files in the repository to mirror this structure.
For example, the 'Version control systems support' page has information for
administrators (ini settings and importing existing repositories) as well as
for users (handling Mercurial subrepositories).

diff -r eddb927e3473 -r e71216a16853 docs/index.rst
--- a/docs/index.rst	Sat Jun 09 21:42:42 2018 +0200
+++ b/docs/index.rst	Wed May 16 21:20:40 2018 +0200
@@ -4,14 +4,21 @@
 Kallithea Documentation
 #######################
 
-**Readme**
+* :ref:`genindex`
+* :ref:`search`
+
+Readme
+------
 
 .. toctree::
    :maxdepth: 1
 
    readme
 
-**Installation**
+Administrator guide
+-------------------
+
+**Installation and upgrade**
 
 .. toctree::
    :maxdepth: 1
@@ -21,11 +28,30 @@
    installation_win
    installation_win_old
    installation_iis
-   setup
    installation_puppet
    upgrade
 
-**Usage**
+**Setup and configuration**
+
+.. toctree::
+   :maxdepth: 1
+
+   setup
+   usage/email
+   usage/customization
+
+**Maintenance**
+
+.. toctree::
+   :maxdepth: 1
+
+   usage/backup
+   usage/performance
+   usage/debugging
+   usage/troubleshooting
+
+User guide
+----------
 
 .. toctree::
    :maxdepth: 1
@@ -34,20 +60,11 @@
    usage/vcs_support
    usage/locking
    usage/statistics
-
-**Administrator's guide**
+   api/api
 
-.. toctree::
-   :maxdepth: 1
 
-   usage/email
-   usage/performance
-   usage/backup
-   usage/debugging
-   usage/troubleshooting
-   usage/customization
-
-**Development**
+Developer guide
+---------------
 
 .. toctree::
    :maxdepth: 1
@@ -56,20 +73,6 @@
    dev/translation
    dev/dbmigrations
 
-**API**
-
-.. toctree::
-   :maxdepth: 1
-
-   api/api
-
-
-Other topics
-************
-
-* :ref:`genindex`
-* :ref:`search`
-
 
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
 .. _python: http://www.python.org/