upstream/kallithea Files · docs/index.rst

docs: reorganize index page...

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).

Thomas De Schampheleire - - Load All Authors

File last commit:

r7254:e71216a1 default


                r7254:e71216a1

default

Download file

             index.rst
        
                    86 lines
            
             | 1.3 KiB
            
                | text/x-rst
            
             |
                RstLexer
            
             / docs / index.rst
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        marcink
    
updated docs, added sphinx build

              r568
            
      .. _index:

        Mads Kiilerich
    
docs: cleanup of casing, markup and spacing of headings...

              r5413
            
      #######################

        Thomas De Schampheleire
    
docs: create separate 'Administrator guide'...

              r4975
            
      Kallithea Documentation

        Mads Kiilerich
    
docs: cleanup of casing, markup and spacing of headings...

              r5413
            
      #######################

        Thomas De Schampheleire
    
docs: reorganize index page...

              r7254
            
      * :ref:`genindex`

      * :ref:`search`

      Readme

      ------

        marcink
    
docs update, setup libs version bumps

              r676
            
        Mads Kiilerich
    
docs: rework stuff...

              r4902
            
      .. toctree::

         :maxdepth: 1

        marcink
    
updated docs, added sphinx build

              r568
            
        Mads Kiilerich
    
docs: rework stuff...

              r4902
            
         readme

        Thomas De Schampheleire
    
docs: reorganize index page...

              r7254
            
      Administrator guide

      -------------------

      **Installation and upgrade**

        marcink
    
updated docs, added sphinx build

              r568
            
      .. toctree::

         :maxdepth: 1

        Mads Kiilerich
    
docs: add installation overview section

              r5081
            
         overview

        marcink
    
updated docs, added sphinx build

              r568
            
         installation

        Denis Blanchette
    
docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...

              r4815
            
         installation_win

        Mads Kiilerich
    
docs: rename docs/installation_win.rst to docs/installation_win_old.rst, preparing for new docs

              r4814
            
         installation_win_old

        Henrik Stuart
    
docs: describe installation under IIS

              r4500
            
         installation_iis

        Robert Rauch
    
docs: add documentation for setup with puppet...

              r5494
            
         installation_puppet

        Søren Løvborg
    
docs: restructure Kallithea upgrade instructions...

              r5917
            
         upgrade

        marcink
    
whitespace cleanup

              r3224
            
        Thomas De Schampheleire
    
docs: reorganize index page...

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

      ----------

        marcink
    
docs updates

              r811
            
      .. toctree::

         :maxdepth: 1

        marcink
    
docs update

              r1025
            
         usage/general

        Thomas De Schampheleire
    
docs/usage: generalize 'git support' into 'version control systems support'...

              r4970
            
         usage/vcs_support

        marcink
    
Implemented basic locking functionality....

              r2726
            
         usage/locking

        marcink
    
docs update

              r1025
            
         usage/statistics

        Thomas De Schampheleire
    
docs: reorganize index page...

              r7254
            
         api/api

        Thomas De Schampheleire
    
docs: create separate 'Administrator guide'...

              r4975
            
        Thomas De Schampheleire
    
docs: reorganize index page...

              r7254
            
      Developer guide

      ---------------

        marcink
    
docs updates

              r811
            
      .. toctree::

         :maxdepth: 1

        marcink
    
whitespace cleanup

              r3224
            
        marcink
    
docs updates

              r811
            
         contributing

        Mads Kiilerich
    
docs: move translation to a separate page...

              r5923
            
         dev/translation

        Søren Løvborg
    
docs: document how to use Alembic for database migrations

              r5986
            
         dev/dbmigrations

        marcink
    
updated docs, added sphinx build

              r568
            
        Mads Kiilerich
    
docs: consistent spacing around headings...

              r5433
            
        marcink
    
more docs update

              r572
            
      .. _virtualenv: http://pypi.python.org/pypi/virtualenv

        marcink
    
updated docs, added sphinx build

              r568
            
      .. _python: http://www.python.org/

      .. _django: http://www.djangoproject.com/

        av6
    
docs: update links to Mercurial's website and wiki...

              r6297
            
      .. _mercurial: https://www.mercurial-scm.org/

        marcink
    
docs update

              r1123
            
      .. _bitbucket: http://bitbucket.org/

        marcink
    
updated docs, added sphinx build

              r568
            
      .. _subversion: http://subversion.tigris.org/

        marcink
    
more docs update

              r572
            
      .. _git: http://git-scm.com/

      .. _celery: http://celeryproject.org/

      .. _Sphinx: http://sphinx.pocoo.org/

        marcink
    
whitespace cleanup

              r3224
            
      .. _vcs: http://pypi.python.org/pypi/vcs

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

marcink updated docs, added sphinx build	r568	.. _index:

Mads Kiilerich docs: cleanup of casing, markup and spacing of headings...	r5413	#######################
Thomas De Schampheleire docs: create separate 'Administrator guide'...	r4975	Kallithea Documentation
Mads Kiilerich docs: cleanup of casing, markup and spacing of headings...	r5413	#######################

Thomas De Schampheleire docs: reorganize index page...	r7254	* :ref:`genindex`
		* :ref:`search`

		Readme
		------
marcink docs update, setup libs version bumps	r676
Mads Kiilerich docs: rework stuff...	r4902	.. toctree::
		:maxdepth: 1
marcink updated docs, added sphinx build	r568
Mads Kiilerich docs: rework stuff...	r4902	readme

Thomas De Schampheleire docs: reorganize index page...	r7254	Administrator guide
		-------------------

		Installation and upgrade
marcink updated docs, added sphinx build	r568
		.. toctree::
		:maxdepth: 1

Mads Kiilerich docs: add installation overview section	r5081	overview
marcink updated docs, added sphinx build	r568	installation
Denis Blanchette docs: update Windows installation documentation for Windows 7/Server 2008 R2 and newer...	r4815	installation_win
Mads Kiilerich docs: rename docs/installation_win.rst to docs/installation_win_old.rst, preparing for new docs	r4814	installation_win_old
Henrik Stuart docs: describe installation under IIS	r4500	installation_iis
Robert Rauch docs: add documentation for setup with puppet...	r5494	installation_puppet
Søren Løvborg docs: restructure Kallithea upgrade instructions...	r5917	upgrade
marcink whitespace cleanup	r3224
Thomas De Schampheleire docs: reorganize index page...	r7254	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
		----------
marcink docs updates	r811
		.. toctree::
		:maxdepth: 1

marcink docs update	r1025	usage/general
Thomas De Schampheleire docs/usage: generalize 'git support' into 'version control systems support'...	r4970	usage/vcs_support
marcink Implemented basic locking functionality....	r2726	usage/locking
marcink docs update	r1025	usage/statistics
Thomas De Schampheleire docs: reorganize index page...	r7254	api/api
Thomas De Schampheleire docs: create separate 'Administrator guide'...	r4975

Thomas De Schampheleire docs: reorganize index page...	r7254	Developer guide
		---------------
marcink docs updates	r811
		.. toctree::
		:maxdepth: 1
marcink whitespace cleanup	r3224
marcink docs updates	r811	contributing
Mads Kiilerich docs: move translation to a separate page...	r5923	dev/translation
Søren Løvborg docs: document how to use Alembic for database migrations	r5986	dev/dbmigrations
marcink updated docs, added sphinx build	r568
Mads Kiilerich docs: consistent spacing around headings...	r5433
marcink more docs update	r572	.. _virtualenv: http://pypi.python.org/pypi/virtualenv
marcink updated docs, added sphinx build	r568	.. _python: http://www.python.org/
		.. _django: http://www.djangoproject.com/
av6 docs: update links to Mercurial's website and wiki...	r6297	.. _mercurial: https://www.mercurial-scm.org/
marcink docs update	r1123	.. _bitbucket: http://bitbucket.org/
marcink updated docs, added sphinx build	r568	.. _subversion: http://subversion.tigris.org/
marcink more docs update	r572	.. _git: http://git-scm.com/
		.. _celery: http://celeryproject.org/
		.. _Sphinx: http://sphinx.pocoo.org/
marcink whitespace cleanup	r3224	.. _vcs: http://pypi.python.org/pypi/vcs