Changeset - 584693b3deb0
[Not reviewed]
default
0 1 0
Thomas De Schampheleire - 11 years ago 2015-04-04 21:39:07
thomas.de.schampheleire@gmail.com
docs/usage: fix section 'trending source files'

The source code reference for the 'trending source files' dictionary was no
longer correct, so update it.
Additionally, some small rewording.
1 file changed with 4 insertions and 4 deletions:
0 comments (0 inline, 0 general)
docs/usage/general.rst
Show inline comments
 
@@ -68,100 +68,100 @@ Viewing all changes between two changese
 
Creating a pull request
 
  You can create a new pull request for the changes of a particular changeset
 
  (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
 

	
 
would get a new URL after moving it to test_group::
 

	
 
  http://server.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,
 
Kallithea provides permanent URLs using the repository ID prefixed with an
 
underscore. In all Kallithea URLs, for example those for the changelog and the
 
file view, a repository name can be replaced by this ``_ID`` string. Since IDs
 
are always the same, moving the repository to a different group will not affect
 
such URLs.
 

	
 
In the example, the repository could also be accessible as::
 

	
 
  http://server.com/_<ID>
 

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

	
 
E-mail notifications
 
--------------------
 

	
 
When the administrator correctly specified the e-mail settings in the Kallithea
 
configuration file, Kallithea will send e-mails on user registration and when
 
errors occur.
 

	
 
Mails are also sent for comments on changesets. In this case, an e-mail is sent
 
to the committer of the changeset (if known to Kallithea), to all reviewers of
 
the pull request (if applicable) and to all people mentioned in the comment
 
using @mention notation.
 

	
 

	
 
Trending source files
 
---------------------
 

	
 
Trending source files are calculated based on a pre-defined dict of known
 
types and extensions. If you miss some extension or would like to scan some
 
custom files, it is possible to add new types in the ``LANGUAGES_EXTENSIONS_MAP`` dict
 
located in ``kallithea/lib/celerylib/tasks.py``.
 
Trending source files are calculated based on a predefined dictionary of known
 
types and extensions. If an extension is missing or you would like to scan
 
custom files, it is possible to extend the ``LANGUAGES_EXTENSIONS_MAP``
 
dictionary located in ``kallithea/config/conf.py`` with new types.
 

	
 

	
 
Cloning remote repositories
 
---------------------------
 

	
 
Kallithea has the ability to clone remote repos from given remote locations.
 
Currently it supports the following options:
 

	
 
- hg  -> hg clone
 
- svn -> hg clone
 
- git -> git clone
 

	
 

	
 
.. note:: svn -> hg cloning requires tge ``hgsubversion`` library to be installed.
 

	
 
If you need to clone repositories that are protected via basic auth, you
 
might pass the url with stored credentials inside, e.g.,
 
``http://user:passw@remote.server/repo``, Kallithea will try to login and clone
 
using the given credentials. Please take note that they will be stored as
 
plaintext inside the database. Kallithea will remove auth info when showing the
 
clone url in summary page.
 

	
 

	
 

	
 
Specific features configurable in the Admin settings
 
----------------------------------------------------
 

	
 
In general, the Admin settings should be self-explanatory and will not be
 
described in more detail in this documentation. However, there are a few
 
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``.
 

	
 
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
 
about a manager of each repository.  There's no limit for adding custom fields.
 
Newly created fields are accessible via the API.
 

	
 
Meta-Tagging
 
~~~~~~~~~~~~
 

	
 
In the `Visual` tab, option `Stylify recognised meta tags` will cause Kallithea
0 comments (0 inline, 0 general)