Mercurial > kallithea

annotate docs/usage/general.rst @ 5413:22a3fa3c4254

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: cleanup of casing, markup and spacing of headings Mostly stuff found and fixed by Søren, extracted here to separate things. Other uses of title casing might be debatable, but here it was just a few documentation headings that clearly were inconsistent with the majority.
author Mads Kiilerich <madski@unity3d.com>
date Thu, 20 Aug 2015 03:26:18 +0200
parents 2079e864ce51
children 5ae8e644aa88
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
4965
a144d15488db docs/usage: rework section 'follow current branch in file view'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4964
diff changeset
30 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
31 --------------------------------
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
32
4965
a144d15488db docs/usage: rework section 'follow current branch in file view'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4964
diff changeset
33 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
34 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
35 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
36 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
37 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
38 ``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
39 arrows will only show revisions on the ``beta`` branch.
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
40
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
41
4966
543bf62d06c7 docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4965
diff changeset
42 Changelog features
543bf62d06c7 docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4965
diff changeset
43 ------------------
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 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
46 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
47 changelog.
543bf62d06c7 docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4965
diff changeset
48
543bf62d06c7 docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4965
diff changeset
49 Branch filter
543bf62d06c7 docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4965
diff changeset
50 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
51 repository. Use the branch filter to restrict to a given branch.
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
52
4966
543bf62d06c7 docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4965
diff changeset
53 Viewing a changeset
543bf62d06c7 docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4965
diff changeset
54 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
55 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
56 ``Show selected changeset`` button at the top.
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
57
4966
543bf62d06c7 docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4965
diff changeset
58 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
59 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
60 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
61 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
62 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
63 checkbox (no cherry-picking).
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
64
4966
543bf62d06c7 docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4965
diff changeset
65 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
66 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
67
543bf62d06c7 docs/usage: reword and extend section on changelog
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4965
diff changeset
68 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
69 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
70 (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
71 for selected changesets`` button.
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
72
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
73 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
74 -------------------------
1813
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
75
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
76 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
77 can often change. For example, a repository originally accessible from::
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
78
1813
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
79 http://server.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
80
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
81 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
82
1813
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
83 http://server.com/test_group/repo_name
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
84
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
85 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
86 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
87 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
88 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
89 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
90 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
91 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
92
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 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
94
a8c66e870bd0 implements #285: Implemented non changeable urls for clone url, and web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
95 http://server.com/_<ID>
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2775
diff changeset
96
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
97 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
98 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
99
5412
2079e864ce51 spelling: use "email" consistently
Søren Løvborg <sorenl@unity3d.com>
parents: 4969
diff changeset
100 Email notifications
2079e864ce51 spelling: use "email" consistently
Søren Løvborg <sorenl@unity3d.com>
parents: 4969
diff changeset
101 -------------------
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
102
5412
2079e864ce51 spelling: use "email" consistently
Søren Løvborg <sorenl@unity3d.com>
parents: 4969
diff changeset
103 When the administrator correctly specified the email settings in the Kallithea
2079e864ce51 spelling: use "email" consistently
Søren Løvborg <sorenl@unity3d.com>
parents: 4969
diff changeset
104 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
105 errors occur.
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
106
5412
2079e864ce51 spelling: use "email" consistently
Søren Løvborg <sorenl@unity3d.com>
parents: 4969
diff changeset
107 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
108 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
109 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
110 using @mention notation.
2105
926f55b038bc added initial rc-extension module
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
111
926f55b038bc added initial rc-extension module
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
112
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
113 Trending source files
1123
9472a0150bf0 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1026
diff changeset
114 ---------------------
1025
bbd499c7b55e docs update
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
115
4968
584693b3deb0 docs/usage: fix section 'trending source files'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4967
diff changeset
116 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
117 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
118 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
119 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
120
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
121
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
122 Cloning remote repositories
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
4969
e5ab200892e3 docs/usage: reword section 'cloning remote repositories'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4968
diff changeset
125 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
126 Currently it supports the following options:
2706
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
127
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
128 - hg -> hg clone
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
129 - svn -> hg clone
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
130 - git -> git clone
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
131
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
132
4969
e5ab200892e3 docs/usage: reword section 'cloning remote repositories'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4968
diff changeset
133 .. 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
134 installed.
2706
22f79562836c Fixed validators for remote repos
Marcin Kuzminski <marcin@python-works.com>
parents: 2105
diff changeset
135
4969
e5ab200892e3 docs/usage: reword section 'cloning remote repositories'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4968
diff changeset
136 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
137 you can pass the credentials in the URL, e.g.
e5ab200892e3 docs/usage: reword section 'cloning remote repositories'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4968
diff changeset
138 ``http://user:passw@remote.server/repo``. Kallithea will then try to login and
e5ab200892e3 docs/usage: reword section 'cloning remote repositories'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4968
diff changeset
139 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
140 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
141 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
142
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
143
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
144 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
145 ----------------------------------------------------
3770
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
146
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
147 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
148 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
149 features that merit further explanation.
3770
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
150
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
151 Repository extra 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
152 ~~~~~~~~~~~~~~~~~~~~~~~
3777
0b6982223baa cleanup code
Marcin Kuzminski <marcin@python-works.com>
parents: 3770
diff changeset
153
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
154 In the `Visual` tab, there is an option `Use repository extra
daa83b2dd1f4 docs/usage: rework and rename section 'Visual settings in admin pannel'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4962
diff changeset
155 fields`, which allows to set custom fields for each repository in the system.
daa83b2dd1f4 docs/usage: rework and rename section 'Visual settings in admin pannel'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4962
diff changeset
156 Each new field consists of 3 attributes: ``field key``, ``field label``,
daa83b2dd1f4 docs/usage: rework and rename section 'Visual settings in admin pannel'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4962
diff changeset
157 ``field description``.
3939
584ec42af63d Updated docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3777
diff changeset
158
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
159 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
160 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
161 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
162 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
163
5413
22a3fa3c4254 docs: cleanup of casing, markup and spacing of headings
Mads Kiilerich <madski@unity3d.com>
parents: 5412
diff changeset
164 Meta tagging
3770
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
165 ~~~~~~~~~~~~
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
166
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
167 In the `Visual` tab, option `Stylify recognised meta tags` will cause Kallithea
daa83b2dd1f4 docs/usage: rework and rename section 'Visual settings in admin pannel'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4962
diff changeset
168 to turn certain meta-tags, detected in repository and repository group
daa83b2dd1f4 docs/usage: rework and rename section 'Visual settings in admin pannel'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4962
diff changeset
169 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
170
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
171 [featured]
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
172 [stale]
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
173 [dead]
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
174 [lang => lang]
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
175 [license => License]
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
176 [requires => Repo]
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
177 [recommends => Repo]
9f5a4e785823 Updated docs regarding visual settings
Marcin Kuzminski <marcin@python-works.com>
parents: 3703
diff changeset
178 [see => URI]