From 74af25be8e0a0a1a3f1004dfe2dcfcd6df3460c4 Mon Sep 17 00:00:00 2001 From: Joost Cassee Date: Sun, 30 Jan 2011 10:33:33 +0100 Subject: [PATCH] Make service documentation less context-dependent It should be possible to understand the service documentation pages without having come from the index page. This is a first step in making them context-independent. --- docs/index.rst | 2 ++ docs/services.rst | 13 ++++++++++++- docs/services/chartbeat.rst | 14 ++++++++++---- docs/services/clicky.rst | 14 ++++++++++---- docs/services/crazy_egg.rst | 14 ++++++++++---- docs/services/google_analytics.rst | 14 ++++++++++---- docs/services/hubspot.rst | 14 ++++++++++---- docs/services/kiss_insights.rst | 14 ++++++++++---- docs/services/kiss_metrics.rst | 14 ++++++++++---- docs/services/mixpanel.rst | 14 ++++++++++---- docs/services/optimizely.rst | 14 ++++++++++---- 11 files changed, 104 insertions(+), 37 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 45ef8b9..a9a6563 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -44,6 +44,8 @@ Contents history +.. _helping-out: + Helping out =========== diff --git a/docs/services.rst b/docs/services.rst index e9e6544..57dec35 100644 --- a/docs/services.rst +++ b/docs/services.rst @@ -4,8 +4,19 @@ Services ======== -A number of analytics services is supported. +This section describes what features are supported by the different +analytics services. To start using a service, you can either use the +generic installation instructions (see :doc:`install`), or add +service-specific tags to your templates. +If you would like to have another analytics service supported by +django-analytical, please create an issue on the project +`issue tracker`_. See also :ref:`helping-out`. + +.. _`issue tracker`: http://github.com/jcassee/django-analytical/issues + + +Currently supported services: .. toctree:: :maxdepth: 1 diff --git a/docs/services/chartbeat.rst b/docs/services/chartbeat.rst index 3f3d942..9de4e5b 100644 --- a/docs/services/chartbeat.rst +++ b/docs/services/chartbeat.rst @@ -12,11 +12,17 @@ slows to a crawl. .. chartbeat-installation: -Adding the template tags -======================== +Installation +============ -You only need to do perform these steps if you are not using the -generic :ttag:`analytical.*` tags. If you are, skip to +To start using the Chartbeat integration, you must have installed the +django-analytical package and have added the ``analytical`` application +to :const:`INSTALLED_APPS` in your project :file:`settings.py` file. +See :doc:`../install` for details. + +Next you need to add the Chartbeat template tags to your templates. This +step is only needed if you are not using the generic +:ttag:`analytical.*` tags. If you are, skip to :ref:`chartbeat-configuration`. The Chartbeat tracking code is inserted into templates using template diff --git a/docs/services/clicky.rst b/docs/services/clicky.rst index 838676d..386267d 100644 --- a/docs/services/clicky.rst +++ b/docs/services/clicky.rst @@ -12,11 +12,17 @@ designed to be very easy to use. .. clicky-installation: -Adding the template tags -======================== +Installation +============ -You only need to do perform these steps if you are not using the -generic :ttag:`analytical.*` tags. If you are, skip to +To start using the Clicky integration, you must have installed the +django-analytical package and have added the ``analytical`` application +to :const:`INSTALLED_APPS` in your project :file:`settings.py` file. +See :doc:`../install` for details. + +Next you need to add the Clicky template tags to your templates. This +step is only needed if you are not using the generic +:ttag:`analytical.*` tags. If you are, skip to :ref:`clicky-configuration`. The Clicky tracking code is inserted into templates using a template diff --git a/docs/services/crazy_egg.rst b/docs/services/crazy_egg.rst index 115421f..def4213 100644 --- a/docs/services/crazy_egg.rst +++ b/docs/services/crazy_egg.rst @@ -11,11 +11,17 @@ web pages that are most important to your visitors. .. crazy-egg-installation: -Adding the template tags -======================== +Installation +============ -You only need to do perform these steps if you are not using the -generic :ttag:`analytical.*` tags. If you are, skip to +To start using the Crazy Egg integration, you must have installed the +django-analytical package and have added the ``analytical`` application +to :const:`INSTALLED_APPS` in your project :file:`settings.py` file. +See :doc:`../install` for details. + +Next you need to add the Crazy Egg template tags to your templates. +This step is only needed if you are not using the generic +:ttag:`analytical.*` tags. If you are, skip to :ref:`crazy-egg-configuration`. The Crazy Egg tracking code is inserted into templates using a template diff --git a/docs/services/google_analytics.rst b/docs/services/google_analytics.rst index fe02ddf..27ec705 100644 --- a/docs/services/google_analytics.rst +++ b/docs/services/google_analytics.rst @@ -12,11 +12,17 @@ features. .. google-analytics-installation: -Adding the template tags -======================== +Installation +============ -You only need to do perform these steps if you are not using the -generic :ttag:`analytical.*` tags. If you are, skip to +To start using the Google Analytics integration, you must have installed +the django-analytical package and have added the ``analytical`` +application to :const:`INSTALLED_APPS` in your project +:file:`settings.py` file. See :doc:`../install` for details. + +Next you need to add the Google Analytics template tags to your +templates. This step is only needed if you are not using the generic +:ttag:`analytical.*` tags. If you are, skip to :ref:`google-analytics-configuration`. The Google Analytics tracking code is inserted into templates using a diff --git a/docs/services/hubspot.rst b/docs/services/hubspot.rst index 53cfe86..59245ae 100644 --- a/docs/services/hubspot.rst +++ b/docs/services/hubspot.rst @@ -11,11 +11,17 @@ tracking on your website to measure effect of your marketing efforts. .. hubspot-installation: -Adding the template tags -======================== +Installation +============ -You only need to do perform these steps if you are not using the -generic :ttag:`analytical.*` tags. If you are, skip to +To start using the HubSpot integration, you must have installed the +django-analytical package and have added the ``analytical`` application +to :const:`INSTALLED_APPS` in your project :file:`settings.py` file. +See :doc:`../install` for details. + +Next you need to add the HubSpot template tags to your templates. This +step is only needed if you are not using the generic +:ttag:`analytical.*` tags. If you are, skip to :ref:`hubspot-configuration`. The HubSpot tracking code is inserted into templates using a template diff --git a/docs/services/kiss_insights.rst b/docs/services/kiss_insights.rst index 0aed9a5..47c3f70 100644 --- a/docs/services/kiss_insights.rst +++ b/docs/services/kiss_insights.rst @@ -11,11 +11,17 @@ the targeted, actionable feedback you need to make your site better. .. kiss-insights-installation: -Adding the template tags -======================== +Installation +============ -You only need to do perform these steps if you are not using the -generic :ttag:`analytical.*` tags. If you are, skip to +To start using the KISSinsights integration, you must have installed the +django-analytical package and have added the ``analytical`` application +to :const:`INSTALLED_APPS` in your project :file:`settings.py` file. +See :doc:`../install` for details. + +Next you need to add the KISSinsights template tags to your templates. +This step is only needed if you are not using the generic +:ttag:`analytical.*` tags. If you are, skip to :ref:`kiss-insights-configuration`. The KISSinsights survey code is inserted into templates using a template diff --git a/docs/services/kiss_metrics.rst b/docs/services/kiss_metrics.rst index 0e120d3..741e38e 100644 --- a/docs/services/kiss_metrics.rst +++ b/docs/services/kiss_metrics.rst @@ -12,11 +12,17 @@ many drop out at each stage. .. kiss-metrics-installation: -Adding the template tags -======================== +Installation +============ -You only need to do perform these steps if you are not using the -generic :ttag:`analytical.*` tags. If you are, skip to +To start using the KISSmetrics integration, you must have installed the +django-analytical package and have added the ``analytical`` application +to :const:`INSTALLED_APPS` in your project :file:`settings.py` file. +See :doc:`../install` for details. + +Next you need to add the KISSmetrics template tags to your templates. +This step is only needed if you are not using the generic +:ttag:`analytical.*` tags. If you are, skip to :ref:`kiss-metrics-configuration`. The KISSmetrics Javascript code is inserted into templates using a diff --git a/docs/services/mixpanel.rst b/docs/services/mixpanel.rst index 3f0f628..1f65bcc 100644 --- a/docs/services/mixpanel.rst +++ b/docs/services/mixpanel.rst @@ -11,11 +11,17 @@ analysis of visitor retention or funnels. .. mixpanel-installation: -Adding the template tags -======================== +Installation +============ -You only need to do perform these steps if you are not using the -generic :ttag:`analytical.*` tags. If you are, skip to +To start using the Mixpanel integration, you must have installed the +django-analytical package and have added the ``analytical`` application +to :const:`INSTALLED_APPS` in your project :file:`settings.py` file. +See :doc:`../install` for details. + +Next you need to add the Mixpanel template tags to your templates. This +step is only needed if you are not using the generic +:ttag:`analytical.*` tags. If you are, skip to :ref:`mixpanel-configuration`. The Mixpanel Javascript code is inserted into templates using a diff --git a/docs/services/optimizely.rst b/docs/services/optimizely.rst index 0ad1a13..16137c4 100644 --- a/docs/services/optimizely.rst +++ b/docs/services/optimizely.rst @@ -12,11 +12,17 @@ retention and sales. .. optimizely-installation: -Adding the template tags -======================== +Installation +============ -You only need to do perform these steps if you are not using the -generic :ttag:`analytical.*` tags. If you are, skip to +To start using the Optimizely integration, you must have installed the +django-analytical package and have added the ``analytical`` application +to :const:`INSTALLED_APPS` in your project :file:`settings.py` file. +See :doc:`../install` for details. + +Next you need to add the Optimizely template tags to your templates. +This step is only needed if you are not using the generic +:ttag:`analytical.*` tags. If you are, skip to :ref:`optimizely-configuration`. The Optimizely Javascript code is inserted into templates using a