Skip to content

Commit

Permalink
[#839] Minor edits to stats extension docs
Browse files Browse the repository at this point in the history
- Edit the opening sentence, it's the stats extension that analyzes the db
  not CKAN (this is picky)
- Also mention that there are tables and graphs!
- Remove weird capitalization in bullet list
- Put built-in page view tracking before ckanext-googleanalytics and tweak
  the link to read a little better
- Add an example of ckan.plugins = stats, also cross-ref to the ckan.plugins
  docs
- Add link to stats page on demo
  • Loading branch information
Sean Hammond committed May 9, 2013
1 parent b9fa87a commit 3fe2bdf
Showing 1 changed file with 24 additions and 18 deletions.
42 changes: 24 additions & 18 deletions doc/stats.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,36 +4,42 @@
Stats Extension
===============

CKAN can analyze its database and display the results with the stats extension.
This extension can show the:
CKAN's stats extension analyzes your CKAN database and displays several tables
and graphs with statistics about your site, including:

* Total Number of Datasets
* Dataset Revisions per Week
* Top Rated Datasets
* Most Edited Datasets
* Largest Groups
* Top Tags
* Users Owning Most Datasets
* Total number of datasets
* Dataset revisions per week
* Top-rated datasets
* Most-edited Datasets
* Largest groups
* Top tags
* Users owning most datasets

.. seealso::

`ckanext-googleanalytics <https://github.com/okfn/ckanext-googleanalytics>`_
A CKAN extension that integrates Google Analytics into CKAN.
CKAN's :ref:`built-in page view tracking feature <tracking>`, which tracks
visits to pages.

.. seealso::

:ref:`tracking`
CKAN can track visits to pages of your site to show and highlight popular datasets.
`ckanext-googleanalytics <https://github.com/okfn/ckanext-googleanalytics>`_
A CKAN extension that integrates Google Analytics into CKAN.


Enabling the Stats Extension
============================

To enable the stats extensions add ``stats`` to ``ckan.plugins`` in the config
file. If you set :ref:`ckanext.stats.cache_enabled` to `true`, CKAN will cache
the stats for one day instead of calculating them each time a user visits the
stats page.
To enable the stats extensions add ``stats`` to the :ref:`ckan.plugins` option
in your CKAN config file, for example::

ckan.plugins = stats

If you also set the :ref:`ckanext.stats.cache_enabled` option to ``true``, CKAN
will cache the stats for one day instead of calculating them each time a user
visits the stats page.

Viewing the Statistics
======================

To visits the statistics, use the URL ``/stats``.
To view the statistics reported by the stats extension, visit the ``/stats``
page, for example: http://demo.ckan.org/stats

0 comments on commit 3fe2bdf

Please sign in to comment.