From f41b0619d80d4bc3db50ad12a78af03c5d34edb6 Mon Sep 17 00:00:00 2001 From: Joost Cassee Date: Sun, 30 Jan 2011 09:56:53 +0100 Subject: [PATCH] Small documentation fixes --- README.rst | 18 +++++++++--------- docs/index.rst | 17 +++++++++-------- docs/services.rst | 1 + docs/tutorial.rst | 6 +++--- 4 files changed, 22 insertions(+), 20 deletions(-) diff --git a/README.rst b/README.rst index d6f1481..c32e25f 100644 --- a/README.rst +++ b/README.rst @@ -4,15 +4,15 @@ django-analytical The django-analytical application integrates various analytics services into a Django_ project. Currently supported services: -* `Chartbeat`_ -- traffic analysis -* `Clicky`_ -- traffic analysis -* `Crazy Egg`_ -- visual click tracking -* `Google Analytics`_ -- traffic analysis -* `HubSpot`_ -- inbound marketing -* `KISSinsights`_ -- feedback surveys -* `KISSmetrics`_ -- funnel analysis -* `Mixpanel`_ -- event tracking -* `Optimizely`_ -- A/B testing +* `Chartbeat`_ traffic analysis +* `Clicky`_ traffic analysis +* `Crazy Egg`_ visual click tracking +* `Google Analytics`_ traffic analysis +* `HubSpot`_ inbound marketing +* `KISSinsights`_ feedback surveys +* `KISSmetrics`_ funnel analysis +* `Mixpanel`_ event tracking +* `Optimizely`_ A/B testing The documentation can be found in the ``docs`` directory or `read online`_. The source code and issue tracker are `hosted on GitHub`_. diff --git a/docs/index.rst b/docs/index.rst index 91ffa25..45ef8b9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -26,7 +26,7 @@ to customize tracking. Each service is set-up as recommended by the services themselves, using an asynchronous version of the Javascript code if possible. -To get a feel of how django-analytics works, first check out the +To get a feel of how django-analytics works, check out the :doc:`tutorial`. @@ -49,14 +49,15 @@ Helping out If you want to help out with development of django-analytical, by posting detailed bug reports, suggesting new features or other analytics -services to support, or doing some development work yourself, please use -the `GitHub project page`_: +services to support, or doing some development work yourself, please see +use the `GitHub project page`_. Use the `issue tracker`_ to discuss +bugs and features. -* Use the `issue tracker`_ to discuss bugs and features. -* If you want to do the work yourself, great! Clone the repository, make - changes and send a pull request. Please create a new issue to discuss - it first, and to keep people from stepping on each others toes. -* Of course, you can always send ideas and patches to joost@cassee.net. +If you want to work on it yourself, great! Clone the repository, make +changes and send a pull request. Please do create a new issue to +discuss your plans. + +Of course, you can always send ideas and patches to joost@cassee.net. .. _`GitHub project page`: http://github.com/jcassee/django-analytical .. _`issue tracker`: http://github.com/jcassee/django-analytical/issues diff --git a/docs/services.rst b/docs/services.rst index 9df77f9..e9e6544 100644 --- a/docs/services.rst +++ b/docs/services.rst @@ -6,6 +6,7 @@ Services A number of analytics services is supported. + .. toctree:: :maxdepth: 1 :glob: diff --git a/docs/tutorial.rst b/docs/tutorial.rst index aac7746..3853e10 100644 --- a/docs/tutorial.rst +++ b/docs/tutorial.rst @@ -21,8 +21,8 @@ tracking data to segment mouse clicks on Crazy Egg based on whether visitors are using IPv4 or IPv6. -Installation -============ +Setting up basic tracking +========================= To get started with django-analytical, the package must first be installed. You can download and install the latest stable package from @@ -128,4 +128,4 @@ using IPv6. This concludes the tutorial. For information about setting up, configuring and customizing the different analytics services, see -:ref:`services`. +:doc:`features` and :doc:`services`.