Mercurial > kallithea
annotate docs/usage/general.rst @ 5713:491961dfd0c8
pytest migration: files: convert to TestControllerPytest and parametrize
Migrate the 'files' tests to pytest and its parametrize decorator.
The syntax of this decorator is slightly different: a first argument is a
comma-separated string with the method argument names for which the values
are provided as second argument.
author | Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> |
---|---|
date | Wed, 10 Feb 2016 18:30:27 +0100 |
parents | ed2fb6e84a02 |
children | 2c3d30095d5e |
rev | line source |
---|---|
1025 | 1 .. _general: |
2 | |
2095 | 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 | 5 ======================= |
6 | |
7 | |
5425
5ae8e644aa88
docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents:
5413
diff
changeset
|
8 Repository deletion |
1123 | 9 ------------------- |
1025 | 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 |
5425
5ae8e644aa88
docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents:
5413
diff
changeset
|
16 There is a special command for cleaning up such archived repositories:: |
3335 | 17 |
4902 | 18 paster cleanup-repos --older-than=30d my.ini |
3335 | 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 | 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 |
5433
fbbe80e3322b
docs: consistent spacing around headings
Mads Kiilerich <madski@unity3d.com>
parents:
5425
diff
changeset
|
30 |
4965
a144d15488db
docs/usage: rework section 'follow current branch in file view'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4964
diff
changeset
|
31 File view: follow current branch |
a144d15488db
docs/usage: rework section 'follow current branch in file view'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4964
diff
changeset
|
32 -------------------------------- |
1025 | 33 |
4965
a144d15488db
docs/usage: rework section 'follow current branch in file view'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4964
diff
changeset
|
34 In the file view, left and right arrows allow to jump to the previous and next |
a144d15488db
docs/usage: rework section 'follow current branch in file view'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4964
diff
changeset
|
35 revision. Depending on the way revisions were created in the repository, this |
a144d15488db
docs/usage: rework section 'follow current branch in file view'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4964
diff
changeset
|
36 could jump to a different branch. When the checkbox ``Follow current branch`` |
a144d15488db
docs/usage: rework section 'follow current branch in file view'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4964
diff
changeset
|
37 is checked, these arrows will only jump to revisions on the same branch as the |
a144d15488db
docs/usage: rework section 'follow current branch in file view'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4964
diff
changeset
|
38 currently visible revision. So for example, if someone is viewing files in the |
a144d15488db
docs/usage: rework section 'follow current branch in file view'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4964
diff
changeset
|
39 ``beta`` branch and marks the `Follow current branch` checkbox, the < and > |
a144d15488db
docs/usage: rework section 'follow current branch in file view'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4964
diff
changeset
|
40 arrows will only show revisions on the ``beta`` branch. |
1025 | 41 |
42 | |
4966
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
43 Changelog features |
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
44 ------------------ |
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
45 |
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
46 The core feature of a repository's ``changelog`` page is to show the revisions |
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
47 in a repository. However, there are several other features available from the |
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
48 changelog. |
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
49 |
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
50 Branch filter |
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
51 By default, the changelog shows revisions from all branches in the |
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
52 repository. Use the branch filter to restrict to a given branch. |
1025 | 53 |
4966
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
54 Viewing a changeset |
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
55 A particular changeset can be opened by clicking on either the changeset |
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
56 hash or the commit message, or by ticking the checkbox and clicking the |
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
57 ``Show selected changeset`` button at the top. |
1025 | 58 |
4966
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
59 Viewing all changes between two changesets |
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
60 To get a list of all changesets between two selected changesets, along with |
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
61 the changes in each one of them, tick the checkboxes of the first and |
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
62 last changeset in the desired range and click the ``Show selected changesets`` |
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
63 button at the top. You can only show the range between the first and last |
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
64 checkbox (no cherry-picking). |
1025 | 65 |
4966
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
66 From that page, you can proceed to viewing the overall delta between the |
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
67 selected changesets, by clicking the ``Compare revisions`` button. |
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
68 |
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
69 Creating a pull request |
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
70 You can create a new pull request for the changes of a particular changeset |
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
71 (and its ancestors) by selecting it and clicking the ``Open new pull request |
543bf62d06c7
docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4965
diff
changeset
|
72 for selected changesets`` button. |
1025 | 73 |
5425
5ae8e644aa88
docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents:
5413
diff
changeset
|
74 |
4967
4185f87f0ee0
docs/usage: rework section on non-changeable repository URLs and call them 'permanent'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4966
diff
changeset
|
75 Permanent repository URLs |
4185f87f0ee0
docs/usage: rework section on non-changeable repository URLs and call them 'permanent'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4966
diff
changeset
|
76 ------------------------- |
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 |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
78 Due to the complicated nature of repository grouping, URLs of repositories |
4967
4185f87f0ee0
docs/usage: rework section on non-changeable repository URLs and call them 'permanent'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4966
diff
changeset
|
79 can often change. For example, a repository originally accessible from:: |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2775
diff
changeset
|
80 |
5497
12b47803189f
cleanup: use example.com for tests and examples
Søren Løvborg <sorenl@unity3d.com>
parents:
5434
diff
changeset
|
81 http://kallithea.example.com/repo_name |
4967
4185f87f0ee0
docs/usage: rework section on non-changeable repository URLs and call them 'permanent'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4966
diff
changeset
|
82 |
4185f87f0ee0
docs/usage: rework section on non-changeable repository URLs and call them 'permanent'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4966
diff
changeset
|
83 would get a new URL after moving it to test_group:: |
4185f87f0ee0
docs/usage: rework section on non-changeable repository URLs and call them 'permanent'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4966
diff
changeset
|
84 |
5497
12b47803189f
cleanup: use example.com for tests and examples
Søren Løvborg <sorenl@unity3d.com>
parents:
5434
diff
changeset
|
85 http://kallithea.example.com/test_group/repo_name |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2775
diff
changeset
|
86 |
4967
4185f87f0ee0
docs/usage: rework section on non-changeable repository URLs and call them 'permanent'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4966
diff
changeset
|
87 Such moving of a repository to a group can be an issue for build systems and |
4185f87f0ee0
docs/usage: rework section on non-changeable repository URLs and call them 'permanent'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4966
diff
changeset
|
88 other scripts where the repository paths are hardcoded. To mitigate this, |
4185f87f0ee0
docs/usage: rework section on non-changeable repository URLs and call them 'permanent'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4966
diff
changeset
|
89 Kallithea provides permanent URLs using the repository ID prefixed with an |
4185f87f0ee0
docs/usage: rework section on non-changeable repository URLs and call them 'permanent'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4966
diff
changeset
|
90 underscore. In all Kallithea URLs, for example those for the changelog and the |
4185f87f0ee0
docs/usage: rework section on non-changeable repository URLs and call them 'permanent'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4966
diff
changeset
|
91 file view, a repository name can be replaced by this ``_ID`` string. Since IDs |
4185f87f0ee0
docs/usage: rework section on non-changeable repository URLs and call them 'permanent'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4966
diff
changeset
|
92 are always the same, moving the repository to a different group will not affect |
4185f87f0ee0
docs/usage: rework section on non-changeable repository URLs and call them 'permanent'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4966
diff
changeset
|
93 such URLs. |
4185f87f0ee0
docs/usage: rework section on non-changeable repository URLs and call them 'permanent'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4966
diff
changeset
|
94 |
4185f87f0ee0
docs/usage: rework section on non-changeable repository URLs and call them 'permanent'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4966
diff
changeset
|
95 In the example, the repository could also be 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
|
96 |
5497
12b47803189f
cleanup: use example.com for tests and examples
Søren Løvborg <sorenl@unity3d.com>
parents:
5434
diff
changeset
|
97 http://kallithea.example.com/_<ID> |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2775
diff
changeset
|
98 |
4967
4185f87f0ee0
docs/usage: rework section on non-changeable repository URLs and call them 'permanent'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4966
diff
changeset
|
99 The ID of a given repository can be shown from the repository ``Summary`` page, |
4185f87f0ee0
docs/usage: rework section on non-changeable repository URLs and call them 'permanent'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4966
diff
changeset
|
100 by selecting the ``Show by ID`` button next to ``Clone URL``. |
1813
a8c66e870bd0
implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
101 |
5425
5ae8e644aa88
docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents:
5413
diff
changeset
|
102 |
5412
2079e864ce51
spelling: use "email" consistently
Søren Løvborg <sorenl@unity3d.com>
parents:
4969
diff
changeset
|
103 Email notifications |
2079e864ce51
spelling: use "email" consistently
Søren Løvborg <sorenl@unity3d.com>
parents:
4969
diff
changeset
|
104 ------------------- |
1025 | 105 |
5425
5ae8e644aa88
docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents:
5413
diff
changeset
|
106 With email settings properly configured in the Kallithea |
5412
2079e864ce51
spelling: use "email" consistently
Søren Løvborg <sorenl@unity3d.com>
parents:
4969
diff
changeset
|
107 configuration file, Kallithea will send emails on user registration and when |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
108 errors occur. |
1025 | 109 |
5412
2079e864ce51
spelling: use "email" consistently
Søren Løvborg <sorenl@unity3d.com>
parents:
4969
diff
changeset
|
110 Emails are also sent for comments on changesets. In this case, an email is sent |
4964
667b5cea6d4f
docs/usage: rework section 'Mailing'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4963
diff
changeset
|
111 to the committer of the changeset (if known to Kallithea), to all reviewers of |
667b5cea6d4f
docs/usage: rework section 'Mailing'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4963
diff
changeset
|
112 the pull request (if applicable) and to all people mentioned in the comment |
667b5cea6d4f
docs/usage: rework section 'Mailing'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4963
diff
changeset
|
113 using @mention notation. |
2105
926f55b038bc
added initial rc-extension module
Marcin Kuzminski <marcin@python-works.com>
parents:
2095
diff
changeset
|
114 |
926f55b038bc
added initial rc-extension module
Marcin Kuzminski <marcin@python-works.com>
parents:
2095
diff
changeset
|
115 |
1025 | 116 Trending source files |
1123 | 117 --------------------- |
1025 | 118 |
4968
584693b3deb0
docs/usage: fix section 'trending source files'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4967
diff
changeset
|
119 Trending source files are calculated based on a predefined dictionary of known |
584693b3deb0
docs/usage: fix section 'trending source files'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4967
diff
changeset
|
120 types and extensions. If an extension is missing or you would like to scan |
584693b3deb0
docs/usage: fix section 'trending source files'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4967
diff
changeset
|
121 custom files, it is possible to extend the ``LANGUAGES_EXTENSIONS_MAP`` |
584693b3deb0
docs/usage: fix section 'trending source files'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4967
diff
changeset
|
122 dictionary located in ``kallithea/config/conf.py`` with new types. |
2706
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
123 |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
124 |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
125 Cloning remote repositories |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
126 --------------------------- |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
127 |
4969
e5ab200892e3
docs/usage: reword section 'cloning remote repositories'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4968
diff
changeset
|
128 Kallithea has the ability to clone repositories from given remote locations. |
4955
4e6dfdb3fa01
docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents:
4902
diff
changeset
|
129 Currently it supports the following options: |
2706
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
130 |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
131 - hg -> hg clone |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
132 - svn -> hg clone |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
133 - git -> git clone |
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
134 |
4969
e5ab200892e3
docs/usage: reword section 'cloning remote repositories'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4968
diff
changeset
|
135 .. note:: svn -> hg cloning requires the ``hgsubversion`` library to be |
e5ab200892e3
docs/usage: reword section 'cloning remote repositories'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4968
diff
changeset
|
136 installed. |
2706
22f79562836c
Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents:
2105
diff
changeset
|
137 |
4969
e5ab200892e3
docs/usage: reword section 'cloning remote repositories'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4968
diff
changeset
|
138 If you need to clone repositories that are protected via basic authentication, |
e5ab200892e3
docs/usage: reword section 'cloning remote repositories'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4968
diff
changeset
|
139 you can pass the credentials in the URL, e.g. |
5497
12b47803189f
cleanup: use example.com for tests and examples
Søren Løvborg <sorenl@unity3d.com>
parents:
5434
diff
changeset
|
140 ``http://user:passw@remote.example.com/repo``. Kallithea will then try to login and |
4969
e5ab200892e3
docs/usage: reword section 'cloning remote repositories'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4968
diff
changeset
|
141 clone using the given credentials. Please note that the given credentials will |
e5ab200892e3
docs/usage: reword section 'cloning remote repositories'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4968
diff
changeset
|
142 be stored as plaintext inside the database. However, the authentication |
e5ab200892e3
docs/usage: reword section 'cloning remote repositories'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4968
diff
changeset
|
143 information will not be shown in the clone URL on the summary page. |
3770
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
144 |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
145 |
4963
daa83b2dd1f4
docs/usage: rework and rename section 'Visual settings in admin pannel'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4962
diff
changeset
|
146 Specific features configurable in the Admin settings |
daa83b2dd1f4
docs/usage: rework and rename section 'Visual settings in admin pannel'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4962
diff
changeset
|
147 ---------------------------------------------------- |
3770
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
148 |
4963
daa83b2dd1f4
docs/usage: rework and rename section 'Visual settings in admin pannel'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4962
diff
changeset
|
149 In general, the Admin settings should be self-explanatory and will not be |
daa83b2dd1f4
docs/usage: rework and rename section 'Visual settings in admin pannel'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4962
diff
changeset
|
150 described in more detail in this documentation. However, there are a few |
daa83b2dd1f4
docs/usage: rework and rename section 'Visual settings in admin pannel'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4962
diff
changeset
|
151 features that merit further explanation. |
3770
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
152 |
4963
daa83b2dd1f4
docs/usage: rework and rename section 'Visual settings in admin pannel'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4962
diff
changeset
|
153 Repository extra fields |
5575
ed2fb6e84a02
docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents:
5497
diff
changeset
|
154 ^^^^^^^^^^^^^^^^^^^^^^^ |
3777 | 155 |
5425
5ae8e644aa88
docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents:
5413
diff
changeset
|
156 In the *Visual* tab, there is an option "Use repository extra |
5ae8e644aa88
docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents:
5413
diff
changeset
|
157 fields", which allows to set custom fields for each repository in the system. |
5ae8e644aa88
docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents:
5413
diff
changeset
|
158 |
5ae8e644aa88
docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents:
5413
diff
changeset
|
159 Once enabled site-wide, the custom fields can be edited per-repository under |
5ae8e644aa88
docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents:
5413
diff
changeset
|
160 *Options* | *Settings* | *Extra Fields*. |
3939 | 161 |
4963
daa83b2dd1f4
docs/usage: rework and rename section 'Visual settings in admin pannel'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4962
diff
changeset
|
162 Example usage of such fields would be to define company-specific information |
daa83b2dd1f4
docs/usage: rework and rename section 'Visual settings in admin pannel'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4962
diff
changeset
|
163 into repositories, e.g., defining a ``repo_manager`` key that would give info |
daa83b2dd1f4
docs/usage: rework and rename section 'Visual settings in admin pannel'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4962
diff
changeset
|
164 about a manager of each repository. There's no limit for adding custom fields. |
daa83b2dd1f4
docs/usage: rework and rename section 'Visual settings in admin pannel'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents:
4962
diff
changeset
|
165 Newly created fields are accessible via the API. |
3770
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
166 |
5413
22a3fa3c4254
docs: cleanup of casing, markup and spacing of headings
Mads Kiilerich <madski@unity3d.com>
parents:
5412
diff
changeset
|
167 Meta tagging |
5575
ed2fb6e84a02
docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents:
5497
diff
changeset
|
168 ^^^^^^^^^^^^ |
3770
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
169 |
5425
5ae8e644aa88
docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents:
5413
diff
changeset
|
170 In the *Visual* tab, option "Stylify recognised meta tags" will cause Kallithea |
5ae8e644aa88
docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents:
5413
diff
changeset
|
171 to turn certain text fragments in repository and repository group |
5ae8e644aa88
docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents:
5413
diff
changeset
|
172 descriptions into colored tags. Currently recognised tags are:: |
3770
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
173 |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
174 [featured] |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
175 [stale] |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
176 [dead] |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
177 [lang => lang] |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
178 [license => License] |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
179 [requires => Repo] |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
180 [recommends => Repo] |
9f5a4e785823
Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents:
3703
diff
changeset
|
181 [see => URI] |