Changeset - 667b5cea6d4f
[Not reviewed]
default
0 1 0
Thomas De Schampheleire - 11 years ago 2015-04-01 22:01:01
thomas.de.schampheleire@gmail.com
docs/usage: rework section 'Mailing'
1 file changed with 8 insertions and 7 deletions:
0 comments (0 inline, 0 general)
docs/usage/general.rst
Show inline comments
 
@@ -55,58 +55,59 @@ Non changeable repository urls
 

	
 
Due to the complicated nature of repository grouping, URLs of repositories
 
can often change.
 

	
 
example::
 

	
 
  #before
 
  http://server.com/repo_name
 
  # after insertion to test_group group the url will be
 
  http://server.com/test_group/repo_name
 

	
 
This can be an issue for build systems and any other hardcoded scripts, moving
 
a repository to a group leads to a need for changing external systems. To
 
overcome this Kallithea introduces a non-changable replacement URL. It's
 
simply a repository ID prefixed with ``_``. The above URLs are also accessible as::
 

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

	
 
Since IDs are always the same, moving the repository will not affect
 
such a URL.  the ``_<ID>`` syntax can be used anywhere in the system so
 
URLs with ``repo_name`` for changelogs and files can be exchanged
 
with the ``_<ID>`` syntax.
 

	
 

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

	
 
When the administrator configures the mailing settings in .ini files
 
Kallithea will send mails on user registration, or when Kallithea
 
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 code comments. If someone comments on a changeset
 
mail is sent to all participants, the person who commited the changeset
 
(if present in Kallithea), and to all people mentioned with the @mention system.
 
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``.
 

	
 

	
 
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.
 

	
0 comments (0 inline, 0 general)