annotate docs/usage/general.rst @ 4962:35d560f0f842

docs/usage: English corrections in 'Repository deleting'
author Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
date Wed, 01 Apr 2015 21:31:19 +0200
parents 4e6dfdb3fa01
children daa83b2dd1f4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
1 .. _general:
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
2
2095
Marcin Kuzminski <marcin@python-works.com>
parents: 1813
diff changeset
3 =======================
4192
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4186
diff changeset
4 General Kallithea usage
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
5 =======================
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
6
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
7
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
8 Repository deleting
1123
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1026
diff changeset
9 -------------------
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
10
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
11 Currently when an admin or owner deletes a repository, Kallithea does
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
12 not physically delete said repository from the filesystem, but instead
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
13 renames it in a special way so that it is not possible to push, clone
4962
35d560f0f842 docs/usage: English corrections in 'Repository deleting'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
14 or access the repository.
35d560f0f842 docs/usage: English corrections in 'Repository deleting'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
15
35d560f0f842 docs/usage: English corrections in 'Repository deleting'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
16 There is a special command for cleaning up such archived repos::
3335
2d4e1f5e854e docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
17
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4192
diff changeset
18 paster cleanup-repos --older-than=30d my.ini
3335
2d4e1f5e854e docs updates
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
19
4962
35d560f0f842 docs/usage: English corrections in 'Repository deleting'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
20 This command scans for archived repositories that are older than
35d560f0f842 docs/usage: English corrections in 'Repository deleting'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
21 30 days, displays them, and asks if you want to delete them (unless given
35d560f0f842 docs/usage: English corrections in 'Repository deleting'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
22 the ``--dont-ask`` flag). If you host a large amount of repositories with
35d560f0f842 docs/usage: English corrections in 'Repository deleting'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
23 forks that are constantly being deleted, it is recommended that you run this
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
24 command via crontab.
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
25
4962
35d560f0f842 docs/usage: English corrections in 'Repository deleting'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
26 It is worth noting that even if someone is given administrative access to
35d560f0f842 docs/usage: English corrections in 'Repository deleting'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
27 Kallithea and deletes a repository, you can easily restore such an action by
35d560f0f842 docs/usage: English corrections in 'Repository deleting'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
28 renaming the repository directory, removing the ``rm__<date>`` prefix.
35d560f0f842 docs/usage: English corrections in 'Repository deleting'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
29
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
30 Follow current branch in file view
1123
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1026
diff changeset
31 ----------------------------------
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
32
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
33 In file view when this checkbox is checked the << and >> arrows will jump
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
34 to changesets within the same branch currently being viewed. So for example
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
35 if someone is viewing files in the ``beta`` branch and marks the `follow current branch`
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
36 checkbox the << and >> buttons will only show revisions for the `'beta`` branch.
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
37
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
38
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
39 Compare view from changelog
1123
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1026
diff changeset
40 ---------------------------
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
41
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
42 Checkboxes in the compare view allow users to view a combined compare
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
43 view. You can only show the range between the first and last checkbox
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
44 (no cherry pick). Clicking more than one checkbox will activate a
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
45 link at the top saying ``Show selected changesets <from-rev> ->
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
46 <to-rev>``. Clicking this will activate the compare view. In this view
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
47 it is also possible to switch to combined compare.
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
48
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
49 Compare view is also available from the journal on pushes having more than
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
50 one changeset.
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
51
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
52
1813
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
53 Non changeable repository urls
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
54 ------------------------------
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
55
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
56 Due to the complicated nature of repository grouping, URLs of repositories
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
57 can often change.
1813
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
58
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
59 example::
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
60
1813
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
61 #before
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
62 http://server.com/repo_name
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
63 # after insertion to test_group group the url will be
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
64 http://server.com/test_group/repo_name
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
65
1813
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
66 This can be an issue for build systems and any other hardcoded scripts, moving
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
67 a repository to a group leads to a need for changing external systems. To
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
68 overcome this Kallithea introduces a non-changable replacement URL. It's
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
69 simply a repository ID prefixed with ``_``. The above URLs are also accessible as::
1813
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
70
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
71 http://server.com/_<ID>
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
72
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
73 Since IDs are always the same, moving the repository will not affect
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
74 such a URL. the ``_<ID>`` syntax can be used anywhere in the system so
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
75 URLs with ``repo_name`` for changelogs and files can be exchanged
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
76 with the ``_<ID>`` syntax.
1813
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
77
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
78
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
79 Mailing
1123
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1026
diff changeset
80 -------
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
81
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
82 When the administrator configures the mailing settings in .ini files
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
83 Kallithea will send mails on user registration, or when Kallithea
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
84 errors occur.
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
85
2105
926f55b038bc added initial rc-extension module
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
86 Mails are also sent for code comments. If someone comments on a changeset
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
87 mail is sent to all participants, the person who commited the changeset
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
88 (if present in Kallithea), and to all people mentioned with the @mention system.
2105
926f55b038bc added initial rc-extension module
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
89
926f55b038bc added initial rc-extension module
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
90
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
91 Trending source files
1123
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1026
diff changeset
92 ---------------------
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
93
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
94 Trending source files are calculated based on a pre-defined dict of known
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
95 types and extensions. If you miss some extension or would like to scan some
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
96 custom files, it is possible to add new types in the ``LANGUAGES_EXTENSIONS_MAP`` dict
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
97 located in ``kallithea/lib/celerylib/tasks.py``.
2706
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
98
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
99
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
100 Cloning remote repositories
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
101 ---------------------------
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
102
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
103 Kallithea has the ability to clone remote repos from given remote locations.
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
104 Currently it supports the following options:
2706
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
105
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
106 - hg -> hg clone
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
107 - svn -> hg clone
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
108 - git -> git clone
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
109
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
110
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
111 .. note:: svn -> hg cloning requires tge ``hgsubversion`` library to be installed.
2706
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
112
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
113 If you need to clone repositories that are protected via basic auth, you
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
114 might pass the url with stored credentials inside, e.g.,
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
115 ``http://user:passw@remote.server/repo``, Kallithea will try to login and clone
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
116 using the given credentials. Please take note that they will be stored as
4192
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4186
diff changeset
117 plaintext inside the database. Kallithea will remove auth info when showing the
2706
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
118 clone url in summary page.
3770
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
119
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
120
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
121
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
122 Visual settings in admin pannel
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
123 -------------------------------
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
124
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
125
4192
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4186
diff changeset
126 Visualisation settings in Kallithea settings view are extra customizations
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
127 of server behavior. There are 3 main sections in the settings.
3770
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
128
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
129 General
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
130 ~~~~~~~
3777
0b6982223baa cleanup code
Marcin Kuzminski <marcin@python-works.com>
parents: 3770
diff changeset
131
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
132 The `Use repository extra fields` option allows to set a custom fields
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
133 for each repository in the system. Each new field consists of 3
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
134 attributes: ``field key``, ``field label``, ``field
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
135 description``. Example usage of such fields would be to define company
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
136 specific information into repositories, e.g., defining a
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
137 ``repo_manager`` key that would give info about a manager of each
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
138 repository. There's no limit for adding custom fields. Newly created
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
139 fields are accessible via API.
3770
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
140
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
141 The `Show Kallithea version` option toggles displaying the exact
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
142 Kallithea version in the footer
3939
584ec42af63d Updated docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3777
diff changeset
143
584ec42af63d Updated docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3777
diff changeset
144
584ec42af63d Updated docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3777
diff changeset
145 Dashboard items
584ec42af63d Updated docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3777
diff changeset
146 ~~~~~~~~~~~~~~~
584ec42af63d Updated docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3777
diff changeset
147
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
148 Number of items in main page dashboard before pagination is displayed.
3939
584ec42af63d Updated docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3777
diff changeset
149
3770
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
150
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
151 Icons
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
152 ~~~~~
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
153
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
154 Show public repo icon / Show private repo icon on repositories - defines if
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
155 public/private icons should be shown in the UI.
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
156
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
157
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
158 Meta-Tagging
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
159 ~~~~~~~~~~~~
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
160
4192
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4186
diff changeset
161 With this option enabled, special metatags that are recognisible by Kallithea
3770
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
162 will be turned into colored tags. Currently available tags are::
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
163
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
164 [featured]
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
165 [stale]
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
166 [dead]
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
167 [lang => lang]
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
168 [license => License]
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
169 [requires => Repo]
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
170 [recommends => Repo]
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
171 [see => URI]