Skip to content

Docs: Split Traffic Analytics to a How-to guide and a Feature entry (Diátaxis) #9677

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
211471e
Re-label Traffic Analysis as a How-To (Diátaxis)
benjaoming Oct 19, 2022
e5d4f56
Improve introduction paragraph
benjaoming Oct 20, 2022
5d6e55c
Update title to reflect contents better, add additional entry in deve…
benjaoming Oct 21, 2022
d650294
Apply suggestions from code review
benjaoming Nov 1, 2022
f75075f
Add Traffic Analytics to the Main Features page
benjaoming Dec 9, 2022
a79593d
Remove How-to from Features
benjaoming Dec 9, 2022
dcc7954
Merge branch 'diataxis/main' of github.com:readthedocs/readthedocs.or…
benjaoming Dec 13, 2022
38a7ade
Add a new Reference / Features section and create a stub for Search A…
benjaoming Dec 13, 2022
5b0dd6c
Merge branch 'diataxis/main' of github.com:readthedocs/readthedocs.or…
benjaoming Dec 20, 2022
d314006
Update screenshot and add more guidance to using the search analytics…
benjaoming Dec 20, 2022
f75dd43
Clarify "Daily search totals"
benjaoming Dec 20, 2022
d823f0c
Clarify what "Download all data" does
benjaoming Dec 20, 2022
a3f04f8
Update docs/user/reference/analytics.rst
benjaoming Dec 20, 2022
0b9b5a9
Rm trailing whitespace
benjaoming Dec 20, 2022
1abc04f
Apply sentence case for titles
benjaoming Dec 21, 2022
a1d46c7
Apply suggestions from code review @ericholscher
benjaoming Dec 22, 2022
d300a3b
Merge branch 'diataxis/main' of github.com:readthedocs/readthedocs.or…
benjaoming Dec 22, 2022
b30c7fa
Merge branch 'diataxis/traffic-analytics-howto' of github.com:benjaom…
benjaoming Dec 22, 2022
fdf2712
Fix white-space lint
benjaoming Dec 22, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions docs/user/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,20 +75,6 @@ We offer a number of search features:

Learn more about :doc:`/server-side-search/index`.

Traffic Analytics
-----------------

Read the Docs aggregates simple statistics about visits to your documentation.

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

If you require more detailed analytics, Read the Docs has native support for Google Analytics.
It's also possible to customize your documentation to include other analytics frameworks.

Learn more in :doc:`/analytics`.

Open Source and Customer Focused
--------------------------------

Expand Down
1 change: 1 addition & 0 deletions docs/user/guides/authors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ and :doc:`/intro/getting-started-with-mkdocs`.
jupyter
Migrate from rST to MyST <migrate-rest-myst>
enable-offline-formats
Using search analytics <search-analytics>
6 changes: 6 additions & 0 deletions docs/user/guides/search-analytics.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
How To Use Search Analytics
===========================

In this guide, you can learn to use Read the Docs' built-in search analytics for your documentation project.

TBC
1 change: 1 addition & 0 deletions docs/user/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ to help you create fantastic documentation for your project.
:glob:

api/index
reference/features


Read the Docs feature overview
Expand Down
38 changes: 38 additions & 0 deletions docs/user/reference/analytics.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
Analytics for Search and Traffic
================================

Read the Docs supports analytics for search and traffic.
When someone reads your documentation,
we collect data about the vist and the referer
with full respect of the privacy of the visitor.


Traffic Analytics
-----------------

Read the Docs aggregates simple statistics about visits to your documentation.

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

If you require more detailed analytics, Read the Docs has native support for Google Analytics.
It's also possible to customize your documentation to include other analytics frameworks.

Learn more in :doc:`/analytics`.


Search Analytics
----------------

When someone visits your documentation using a search engine,
Read the Docs will collect analytics on their search term.

Those are aggregated into a simple view of the
"Top queries in the past 30 days".
You can also download this data.

This is helpful to optimize your documentation in alignment with your readers' interests.
You can discover new trends and expand your documentation to new needs.

Learn more in :doc:`/guides/search-analytics`.
9 changes: 9 additions & 0 deletions docs/user/reference/features.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
========
Features
========


.. toctree::
:maxdepth: 1

analytics