From 4dae5b4250246a722357cf48a5c8d642560f9c4a Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Tue, 20 Mar 2012 11:21:17 +0000 Subject: [PATCH] [#2226,doc/commenting][s]: add documentation re comments and commenting functionality in CKAN. --- doc/commenting.rst | 23 +++++++++++++++++++++++ doc/index.rst | 1 + 2 files changed, 24 insertions(+) create mode 100644 doc/commenting.rst diff --git a/doc/commenting.rst b/doc/commenting.rst new file mode 100644 index 00000000000..5db444f19a9 --- /dev/null +++ b/doc/commenting.rst @@ -0,0 +1,23 @@ +======================= +Comments and Commenting +======================= + +In a default CKAN install commenting is disabled. To enable it you have to +install and enable the disqus (commenting) extension: + +https://github.com/okfn/ckanext-disqus/ + +Please read and follow the instructions there (as well as the standard +:doc:`extensions` documentation). + +Important Note +-------------- + +Once installed and enabled, the presence of comments on a given page is +configured by your theme (see the documentation in the disqus extension for +details). + +In the default CKAN theme (as of v1.6.1), comments will be shown only on dataset +and resource pages (and recent comments only on the +:doc:`administrative-dashboard`). + diff --git a/doc/index.rst b/doc/index.rst index a5cc0befe02..408000f2a3b 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -29,6 +29,7 @@ Customizing and Extending :maxdepth: 2 theming + commenting extensions writing-extensions forms