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.
This commit is contained in:
Joost Cassee 2011-01-30 10:33:33 +01:00
parent ef56199d1e
commit 74af25be8e
11 changed files with 104 additions and 37 deletions

View file

@ -44,6 +44,8 @@ Contents
history
.. _helping-out:
Helping out
===========

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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