comparison 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
comparison
equal deleted inserted replaced
7331:eddb927e3473 7332:e71216a16853
2 2
3 ####################### 3 #######################
4 Kallithea Documentation 4 Kallithea Documentation
5 ####################### 5 #######################
6 6
7 **Readme** 7 * :ref:`genindex`
8 * :ref:`search`
9
10 Readme
11 ------
8 12
9 .. toctree:: 13 .. toctree::
10 :maxdepth: 1 14 :maxdepth: 1
11 15
12 readme 16 readme
13 17
14 **Installation** 18 Administrator guide
19 -------------------
20
21 **Installation and upgrade**
15 22
16 .. toctree:: 23 .. toctree::
17 :maxdepth: 1 24 :maxdepth: 1
18 25
19 overview 26 overview
20 installation 27 installation
21 installation_win 28 installation_win
22 installation_win_old 29 installation_win_old
23 installation_iis 30 installation_iis
24 setup
25 installation_puppet 31 installation_puppet
26 upgrade 32 upgrade
27 33
28 **Usage** 34 **Setup and configuration**
35
36 .. toctree::
37 :maxdepth: 1
38
39 setup
40 usage/email
41 usage/customization
42
43 **Maintenance**
44
45 .. toctree::
46 :maxdepth: 1
47
48 usage/backup
49 usage/performance
50 usage/debugging
51 usage/troubleshooting
52
53 User guide
54 ----------
29 55
30 .. toctree:: 56 .. toctree::
31 :maxdepth: 1 57 :maxdepth: 1
32 58
33 usage/general 59 usage/general
34 usage/vcs_support 60 usage/vcs_support
35 usage/locking 61 usage/locking
36 usage/statistics 62 usage/statistics
63 api/api
37 64
38 **Administrator's guide**
39 65
40 .. toctree:: 66 Developer guide
41 :maxdepth: 1 67 ---------------
42
43 usage/email
44 usage/performance
45 usage/backup
46 usage/debugging
47 usage/troubleshooting
48 usage/customization
49
50 **Development**
51 68
52 .. toctree:: 69 .. toctree::
53 :maxdepth: 1 70 :maxdepth: 1
54 71
55 contributing 72 contributing
56 dev/translation 73 dev/translation
57 dev/dbmigrations 74 dev/dbmigrations
58
59 **API**
60
61 .. toctree::
62 :maxdepth: 1
63
64 api/api
65
66
67 Other topics
68 ************
69
70 * :ref:`genindex`
71 * :ref:`search`
72 75
73 76
74 .. _virtualenv: http://pypi.python.org/pypi/virtualenv 77 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
75 .. _python: http://www.python.org/ 78 .. _python: http://www.python.org/
76 .. _django: http://www.djangoproject.com/ 79 .. _django: http://www.djangoproject.com/