Mercurial > kallithea
annotate docs/usage/statistics.rst @ 4902:03bbd33bc084
docs: rework stuff
The existing docs were far from how we wanted it to be. There was so much to do
and it is not feasible to do that cleanup it in clean patches.
Instead, I took a sweep through the docs and changed what I thought could
benefit from a change: structure, examples, advices, language, markup, content,
etc.
author | Mads Kiilerich <madski@unity3d.com> |
---|---|
date | Wed, 11 Mar 2015 16:10:30 +0100 |
parents | e73a69cb98dc |
children | 4e6dfdb3fa01 |
rev | line source |
---|---|
811 | 1 .. _statistics: |
2 | |
2095 | 3 ========== |
811 | 4 Statistics |
5 ========== | |
6 | |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
2096
diff
changeset
|
7 The Kallithea statistics system makes heavy demands of the server resources, so |
1092
8af52e1224ff
merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents:
1025
diff
changeset
|
8 in order to keep a balance between usability and performance, the statistics are |
4902 | 9 cached inside db and are gathered incrementally. This is how Kallithea does |
1092
8af52e1224ff
merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents:
1025
diff
changeset
|
10 this: |
811 | 11 |
12 With Celery disabled | |
1123 | 13 -------------------- |
811 | 14 |
1092
8af52e1224ff
merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents:
1025
diff
changeset
|
15 - On each first visit to the summary page a set of 250 commits are parsed and |
8af52e1224ff
merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents:
1025
diff
changeset
|
16 updates statistics cache. |
8af52e1224ff
merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents:
1025
diff
changeset
|
17 - This happens on each single visit to the statistics page until all commits are |
8af52e1224ff
merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents:
1025
diff
changeset
|
18 fetched. Statistics are kept cached until additional commits are added to the |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
2096
diff
changeset
|
19 repository. In such a case Kallithea will only fetch the new commits when |
1092
8af52e1224ff
merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents:
1025
diff
changeset
|
20 updating it's cache. |
811 | 21 |
22 | |
23 With Celery enabled | |
1123 | 24 ------------------- |
811 | 25 |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
2096
diff
changeset
|
26 - On the first visit to the summary page Kallithea will create tasks that will |
1092
8af52e1224ff
merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents:
1025
diff
changeset
|
27 execute on celery workers. This task will gather all of the stats until all |
8af52e1224ff
merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents:
1025
diff
changeset
|
28 commits are parsed, each task will parse 250 commits, and run the next task to |
8af52e1224ff
merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents:
1025
diff
changeset
|
29 parse next 250 commits, until all of the commits are parsed. |
811 | 30 |
31 .. note:: | |
1092
8af52e1224ff
merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents:
1025
diff
changeset
|
32 At any time you can disable statistics on each repository via the repository |
8af52e1224ff
merge docs in beta with those corrected by Jason Harris
Marcin Kuzminski <marcin@python-works.com>
parents:
1025
diff
changeset
|
33 edit form in the admin panel. To do this just uncheck the statistics checkbox. |