Skip to content

Commit a34972f

Browse files
committed
Merge Google Analytics content into Traffic Analytics
1 parent d9c8752 commit a34972f

File tree

5 files changed

+37
-44
lines changed

5 files changed

+37
-44
lines changed

docs/advertising/advertising-details.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,13 +119,13 @@ our own goals.
119119

120120
We have taken steps to address some of the privacy concerns surrounding GA.
121121
These steps apply both to analytics collected by Read the Docs and when
122-
:doc:`authors enable analytics on their docs </google-analytics>`.
122+
:ref:`authors enable analytics on their docs <analytics:Enabling Google Analytics on your Project>`.
123123

124124
* Users can opt-out of analytics by using the Do Not Track feature of their browser.
125125
* Read the Docs instructs Google to anonymize IP addresses sent to them.
126126
* The cookies set by GA expire in 30 days rather than the default 2 years.
127127
* Project maintainers can completely disable analytics on their own projects.
128-
Follow the steps in :ref:`google-analytics:Disabling Google Analytics on your project`.
128+
Follow the steps in :ref:`analytics:Disabling Google Analytics on your project`.
129129

130130

131131
Why we use analytics

docs/analytics.rst

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
Analytics
2-
---------
1+
Traffic Analytics
2+
=================
33

4-
Analytics lets you see *which* documents your users are reading.
4+
Traffic Analytics lets you see *which* documents your users are reading.
55
This allows you to understand how your documentation is being used,
66
so you can focus on expanding and updating parts people are reading most.
77

@@ -18,7 +18,36 @@ and then click on :guilabel:`Traffic Analytics`.
1818

1919
You can also access to analytics data from :ref:`search results <server-side-search:analytics>`.
2020

21+
Enabling Google Analytics on your Project
22+
-----------------------------------------
23+
24+
Read the Docs has native support for Google Analytics.
25+
You can enable it by:
26+
27+
* Going to :guilabel:`Admin` > :guilabel:`Advanced Settings` in your project.
28+
* Fill in the **Analytics code** heading with your Google Tracking ID (example `UA-123456674-1`)
29+
30+
Once your documentation rebuilds it will include your Analytics tracking code and start sending data.
31+
Google Analytics usually takes 60 minutes,
32+
and sometimes can take up to a day before it starts reporting data.
33+
2134
.. note::
2235

23-
If you require more information about page views,
24-
you can use a solution like :doc:`Google Analytics </google-analytics>`.
36+
Read the Docs takes some extra precautions with analytics to protect user privacy.
37+
As a result, users with Do Not Track enabled will not be counted
38+
for the purpose of analytics.
39+
40+
For more details, see the
41+
:ref:`Do Not Track section <privacy-policy:Do Not Track>`
42+
of our privacy policy.
43+
44+
Disabling Google Analytics on your project
45+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
46+
47+
Google Analytics can be completely disabled on your own projects.
48+
To disable Google Analytics:
49+
50+
* Going to :guilabel:`Admin` > :guilabel:`Advanced Settings` in your project.
51+
* Check the box **Disable Analytics**.
52+
53+
Your documentation will need to be rebuilt for this change to take effect.

docs/google-analytics.rst

Lines changed: 0 additions & 34 deletions
This file was deleted.

docs/guides/technical-docs-seo-guide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ Some of the most valuable feedback these provide include:
266266
Analytics tools
267267
~~~~~~~~~~~~~~~
268268

269-
A tool like :doc:`Google Analytics </google-analytics>`
269+
A tool like :ref:`Google Analytics <analytics:Enabling Google Analytics on your Project>`
270270
can give you feedback about the search terms people use to find your docs,
271271
your most popular pages, and lots of other useful data.
272272

docs/index.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,6 @@ and some of the core features of Read the Docs.
8282
:doc:`/hosting` |
8383
:doc:`/server-side-search` |
8484
:doc:`/analytics` |
85-
:doc:`/google-analytics` |
8685
:doc:`/pull-requests` |
8786
:doc:`/build-notifications` |
8887
:doc:`/user-defined-redirects`
@@ -114,7 +113,6 @@ and some of the core features of Read the Docs.
114113
/hosting
115114
/server-side-search
116115
/analytics
117-
/google-analytics
118116
/pull-requests
119117
/build-notifications
120118

0 commit comments

Comments
 (0)