Mercurial > kallithea

comparison docs/usage/general.rst @ 4963:daa83b2dd1f4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs/usage: rework and rename section 'Visual settings in admin pannel' - remove trivial items that are already explained on the settings page itself - rename section to reflect this new scope - general rewording
author Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
date Wed, 01 Apr 2015 21:53:37 +0200
parents 35d560f0f842
children 667b5cea6d4f
comparison
equal deleted inserted replaced
4962:35d560f0f842 4963:daa83b2dd1f4
117 plaintext inside the database. Kallithea will remove auth info when showing the 117 plaintext inside the database. Kallithea will remove auth info when showing the
118 clone url in summary page. 118 clone url in summary page.
119 119
120 120
121 121
122 Visual settings in admin pannel 122 Specific features configurable in the Admin settings
123 ------------------------------- 123 ----------------------------------------------------
124 124
125 In general, the Admin settings should be self-explanatory and will not be
126 described in more detail in this documentation. However, there are a few
127 features that merit further explanation.
125 128
126 Visualisation settings in Kallithea settings view are extra customizations 129 Repository extra fields
127 of server behavior. There are 3 main sections in the settings. 130 ~~~~~~~~~~~~~~~~~~~~~~~
128 131
129 General 132 In the `Visual` tab, there is an option `Use repository extra
130 ~~~~~~~ 133 fields`, which allows to set custom fields for each repository in the system.
134 Each new field consists of 3 attributes: ``field key``, ``field label``,
135 ``field description``.
131 136
132 The `Use repository extra fields` option allows to set a custom fields 137 Example usage of such fields would be to define company-specific information
133 for each repository in the system. Each new field consists of 3 138 into repositories, e.g., defining a ``repo_manager`` key that would give info
134 attributes: ``field key``, ``field label``, ``field 139 about a manager of each repository. There's no limit for adding custom fields.
135 description``. Example usage of such fields would be to define company 140 Newly created fields are accessible via the API.
136 specific information into repositories, e.g., defining a
137 ``repo_manager`` key that would give info about a manager of each
138 repository. There's no limit for adding custom fields. Newly created
139 fields are accessible via API.
140
141 The `Show Kallithea version` option toggles displaying the exact
142 Kallithea version in the footer
143
144
145 Dashboard items
146 ~~~~~~~~~~~~~~~
147
148 Number of items in main page dashboard before pagination is displayed.
149
150
151 Icons
152 ~~~~~
153
154 Show public repo icon / Show private repo icon on repositories - defines if
155 public/private icons should be shown in the UI.
156
157 141
158 Meta-Tagging 142 Meta-Tagging
159 ~~~~~~~~~~~~ 143 ~~~~~~~~~~~~
160 144
161 With this option enabled, special metatags that are recognisible by Kallithea 145 In the `Visual` tab, option `Stylify recognised meta tags` will cause Kallithea
162 will be turned into colored tags. Currently available tags are:: 146 to turn certain meta-tags, detected in repository and repository group
147 descriptions, into colored tags. Currently recognised tags are::
163 148
164 [featured] 149 [featured]
165 [stale] 150 [stale]
166 [dead] 151 [dead]
167 [lang => lang] 152 [lang => lang]