kallithea Changeset - 9f5a4e785823

Changeset - 9f5a4e785823

Parent rev.

Child rev.

[Not reviewed]

beta

0 1 0

Marcin Kuzminski - 13 years ago 2013-04-19 16:20:14
marcin@python-works.com

Updated docs regarding visual settings

1 file changed with 44 insertions and 0 deletions:

docs/usage/general.rst

0 comments (0 inline, 0 general)

docs/usage/general.rst

➞

Show inline comments

@@ @@ -68,48 +68,92 @@ simply an repository ID prefixed with `_ @@
 Since ID are always the same moving the repository will not affect such url.
 the _<ID> syntax can be used anywhere in the system so urls with repo_name
 for changelogs, files and other can be exchanged with _<ID> syntax.
 Mailing
 -------
 When administrator will fill up the mailing settings in .ini files
 RhodeCode will send mails on user registration, or when RhodeCode errors occur
 on errors the mails will have a detailed traceback of error.
 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 RhodeCode), and to all people mentioned with @mention system.
 Trending source files
 ---------------------
 Trending source files are calculated based on pre defined dict of known
 types and extensions. If You miss some extension or Would like to scan some
 custom files it's possible to add new types in `LANGUAGES_EXTENSIONS_MAP` dict
 located in `/rhodecode/lib/celerylib/tasks.py`
 Cloning remote repositories
 ---------------------------
 RhodeCode has an ability to clone remote repos from given remote locations.
 Currently it support following options:
 - hg  -> hg clone
 - svn -> hg clone
 - git -> git clone
 .. note::
     - *`svn -> hg` cloning requires `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 eg.
 `http://user:passw@remote.server/repo`, RhodeCode will try to login and clone
 using given credentials. Please take a note that they will be stored as
 plaintext inside the database. RhodeCode will remove auth info when showing the
 clone url in summary page.
 Visual settings in admin pannel
 -------------------------------
 Visualisation settings in RhodeCode settings view are extra customizations
 of server behavior. There are 3 main section in the settings.
 General
 ~~~~~~~
 `Use repository extra fields` option allows to set a 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 eg. defining repo_manager
 key that would add give info about a manager of each repository. There's no
 limit for adding custom fields. Newly created fields are accessible via API.
 Icons
 ~~~~~
 Show public repo icon / Show private repo icon on repositories - defines if
 public/private icons should be shown in the UI.
 Meta-Tagging
 ~~~~~~~~~~~~
 With this option enabled, special metatags that are recognisible by RhodeCode
 will be turned into colored tags. Currently available tags are::
     [featured]
     [stale]
     [dead]
     [lang => lang]
     [license => License]
     [requires => Repo]
     [recommends => Repo]
     [see => URI]

0 comments (0 inline, 0 general)