kallithea Files · docs/index.rst

Files @ 2d6ec8b9b633

Branch filter:

Location: kallithea/docs/index.rst

2d6ec8b9b633 1.2 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

Thomas De Schampheleire

email templates: reorder references to pullrequests

The current references to PRs in email templates are:

Pull request from <repo> branch <branch> to <repo> branch <branch>:
<niceid> <title> by <user>

as the first line can become very long and therefore hard to read, a first
step is to introduce a newline before the destination branch:

Pull request from <repo> branch <branch>
to <repo> branch <branch>:
<niceid> <title> by <user>

But it would be nicer if the from/to part aligns more.
Moreover, the most useful part is (hopefully) the PR title, the from/to is
secondary and can sometimes even be inferred from the title and context the
recipient is already aware of.

Thus, this commit proposes the following format:

Pull request <niceid> <title> by <user>
from <repo> branch <branch>
to <repo> branch <branch>

This adds some divergence with the changeset references, which could be
aligned later if desired.

.. _index:

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

**Readme**

.. toctree::
   :maxdepth: 1

   readme

**Installation**

.. toctree::
   :maxdepth: 1

   overview
   installation
   installation_win
   installation_win_old
   installation_iis
   setup
   installation_puppet
   upgrade

**Usage**

.. toctree::
   :maxdepth: 1

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

**Administrator's guide**

.. toctree::
   :maxdepth: 1

   usage/email
   usage/performance
   usage/backup
   usage/debugging
   usage/troubleshooting
   usage/customization

**Development**

.. toctree::
   :maxdepth: 1

   contributing
   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/
.. _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