Skip to content

Commit

Permalink
[#541] Add docs for highlighting popular datasets and resources
Browse files Browse the repository at this point in the history
Also mention that tracking summary data is also available for resources
via the API, not just packages.
  • Loading branch information
Sean Hammond committed Apr 3, 2013
1 parent ca04063 commit 8d4c366
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 2 deletions.
Binary file added doc/images/popular-dataset.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/popular-resource.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 15 additions & 2 deletions doc/tracking.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,9 @@ You can retrieve datasets most-popular-first from the

.. tip::

Tracking summary data for datasets is available in the dataset dictionaries
returned by, for example, the ``package_show()`` API::
Tracking summary data for datasets and resources is available in the dataset
and resource dictionaries returned by, for example, the ``package_show()``
API::

"tracking_summary": {
"recent": 5,
Expand All @@ -81,6 +82,18 @@ You can retrieve datasets most-popular-first from the
Page view counting is limited to one view per user per page per day.


Highlighting Popular Datasets and Resources
===========================================

Once you've enabled page view tracking on your CKAN site, popular datasets and
resources (those with more than 10 views) will be highlighted with a "popular"
badge and a tooltip showing the number of views:

.. image:: images/popular-dataset.png

.. image:: images/popular-resource.png


Exporting Tracking Data
=======================

Expand Down

0 comments on commit 8d4c366

Please sign in to comment.