view docs/index.rst @ 7332:e71216a16853

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).
author Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
date Wed, 16 May 2018 21:20:40 +0200
parents 9c6f717823e1
children 2cbdbf55ed99
line wrap: on
line source

.. _index:

#######################
Kallithea Documentation
#######################

* :ref:`genindex`
* :ref:`search`

Readme
------

.. toctree::
   :maxdepth: 1

   readme

Administrator guide
-------------------

**Installation and upgrade**

.. toctree::
   :maxdepth: 1

   overview
   installation
   installation_win
   installation_win_old
   installation_iis
   installation_puppet
   upgrade

**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

   usage/general
   usage/vcs_support
   usage/locking
   usage/statistics
   api/api


Developer guide
---------------

.. toctree::
   :maxdepth: 1

   contributing
   dev/translation
   dev/dbmigrations


.. _virtualenv: http://pypi.python.org/pypi/virtualenv
.. _python: http://www.python.org/
.. _django: http://www.djangoproject.com/
.. _mercurial: https://www.mercurial-scm.org/
.. _bitbucket: http://bitbucket.org/
.. _subversion: http://subversion.tigris.org/
.. _git: http://git-scm.com/
.. _celery: http://celeryproject.org/
.. _Sphinx: http://sphinx.pocoo.org/
.. _vcs: http://pypi.python.org/pypi/vcs