diff --git a/docs/usage/general.rst b/docs/usage/general.rst --- a/docs/usage/general.rst +++ b/docs/usage/general.rst @@ -5,7 +5,7 @@ General Kallithea usage ======================= -Repository deleting +Repository deletion ------------------- Currently when an admin or owner deletes a repository, Kallithea does @@ -13,7 +13,7 @@ not physically delete said repository fr renames it in a special way so that it is not possible to push, clone or access the repository. -There is a special command for cleaning up such archived repos:: +There is a special command for cleaning up such archived repositories:: paster cleanup-repos --older-than=30d my.ini @@ -70,17 +70,18 @@ Creating a pull request (and its ancestors) by selecting it and clicking the ``Open new pull request for selected changesets`` button. + Permanent repository URLs ------------------------- Due to the complicated nature of repository grouping, URLs of repositories can often change. For example, a repository originally accessible from:: - http://server.com/repo_name + http://example.com/repo_name would get a new URL after moving it to test_group:: - http://server.com/test_group/repo_name + http://example.com/test_group/repo_name Such moving of a repository to a group can be an issue for build systems and other scripts where the repository paths are hardcoded. To mitigate this, @@ -92,15 +93,16 @@ such URLs. In the example, the repository could also be accessible as:: - http://server.com/_ + http://example.com/_ The ID of a given repository can be shown from the repository ``Summary`` page, by selecting the ``Show by ID`` button next to ``Clone URL``. + Email notifications ------------------- -When the administrator correctly specified the email settings in the Kallithea +With email settings properly configured in the Kallithea configuration file, Kallithea will send emails on user registration and when errors occur. @@ -151,10 +153,11 @@ features that merit further explanation. Repository extra fields ~~~~~~~~~~~~~~~~~~~~~~~ -In the `Visual` tab, there is an option `Use repository extra -fields`, which allows to set custom fields for each repository in the system. -Each new field consists of 3 attributes: ``field key``, ``field label``, -``field description``. +In the *Visual* tab, there is an option "Use repository extra +fields", which allows to set custom fields for each repository in the system. + +Once enabled site-wide, the custom fields can be edited per-repository under +*Options* | *Settings* | *Extra Fields*. Example usage of such fields would be to define company-specific information into repositories, e.g., defining a ``repo_manager`` key that would give info @@ -164,9 +167,9 @@ Newly created fields are accessible via Meta tagging ~~~~~~~~~~~~ -In the `Visual` tab, option `Stylify recognised meta tags` will cause Kallithea -to turn certain meta-tags, detected in repository and repository group -descriptions, into colored tags. Currently recognised tags are:: +In the *Visual* tab, option "Stylify recognised meta tags" will cause Kallithea +to turn certain text fragments in repository and repository group +descriptions into colored tags. Currently recognised tags are:: [featured] [stale]