documentation/content/applications/websites/website/optimize/google_analytics_dashboard.rst
Antoine Vandevenne (anv) e3fee2cf46 [REF][MOV] documentation apocalypse
Prior to this commit, the Odoo documentation was mainly split between
two repositories: odoo/odoo/doc and odoo/documentation-user. Some bits
of documentation were also hosted elsewhere (e.g., wiki, upgrade, ...).
This was causing several problems among which:
  - The theme, config, Makefile, and similar technical resources had to
    be duplicated. This resulted in inconsistent layout, features, and
    build environments from one documentation to another.
  - Some pages did not fit either documentation as they were relevant
    for both users and developers. Some were relevant to neither of the
    two (e.g., DB management).
  - Cross-doc references had to be absolute links and they broke often.
  - Merging large image files in the developer documentation would bloat
    the odoo/odoo repository. Some contributions had to be lightened to
    avoid merging too many images (e.g., Odoo development tutorials).
  - Long-time contributors to the user documentation were chilly about
    going through the merging process of the developer documentation
    because of the runbot, mergebot, `odoo-dev` repository, etc.
  - Some contributors would look for the developer documentation in the
    `odoo/documentation-user` repository.
  - Community issues about the user documentation were submitted on the
    `odoo/odoo` repository and vice-versa.

Merging all documentations in one repository will allow us to have one
place, one theme, one work process, and one set of tools (build
environment, ...) for all of the Odoo docs.

As this is a good opportunity to revamp the layout of the documentation,
a brand new theme replaces the old one. It features a new way to
navigate the documentation, centered on the idea of always letting the
reader know what is the context (enclosing section, child pages, page
structure ...) of the page they are reading. The previous theme would
quickly confuse readers as they navigated the documentation and followed
cross-application links.

The chance is also taken to get rid of all the technical dangling parts,
performance issues, and left-overs. Except for some page-specific JS
scripts, the Odoo theme Sphinx extension is re-written from scratch
based on the latest Sphinx release to benefit from the improvements and
ease future contributions.

task-2351938
task-2352371
task-2205684
task-2352544

Closes #945
2021-05-04 15:44:00 +02:00

71 lines
2.3 KiB
ReStructuredText

==========================================================
How to track your website traffic from your Odoo Dashboard
==========================================================
You can follow your traffic statistics straight from your Odoo Website
Dashboard thanks to Google Analytics.
- A preliminary step is creating a Google Analytics account and entering the
tracking ID in your Website's settings (see :doc:`google_analytics`).
- Go to `Google APIs platform <https://console.developers.google.com>`__
to generate Analytics API credentials. Log in with your Google account.
- Select Analytics API.
.. image:: media/google_analytics_api.png
:align: center
- Create a new project and give it a name (e.g. Odoo).
This project is needed to store your API credentials.
.. image:: media/google_analytics_create_project.png
:align: center
- Enable the API.
.. image:: media/google_analytics_enable.png
:align: center
- Create credentials to use in Odoo.
.. image:: media/google_analytics_create_credentials.png
:align: center
- Select *Web browser (Javascript)*
as calling source and *User data* as kind of data.
.. image:: media/google_analytics_get_credentials.png
:align: center
- Then you can create a Client ID.
Enter the name of the application (e.g. Odoo) and the allowed pages on
which you will be redirected. The *Authorized JavaScript origin* is your
Odoo's instance URL. The *Authorized redirect URI* is your Odoo's instance
URL followed by '/google_account/authentication'.
.. image:: media/google_analytics_authorization.png
:align: center
- Go through the Consent Screen step by entering a product name
(e.g. Google Analytics in Odoo). Feel free to check the customizations options
but this is not mandatory. The Consent Screen will only show up when you enter
the Client ID in Odoo for the first time.
- Finally you are provided with your Client ID. Copy and paste it in Odoo.
.. image:: media/google_analytics_client_id.png
:align: center
- Open your Website Dashboard in Odoo and link your Analytics account.
to past your Client ID.
.. image:: media/google_analytics_start.png
:align: center
- As a last step, authorize Odoo to access Google API.
.. image:: media/google_analytics_login.png
:align: center