-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
benjaoming
merged 19 commits into
readthedocs:diataxis/main
from
benjaoming:diataxis/traffic-analytics-howto
Dec 22, 2022
Merged
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 e5d4f56
Improve introduction paragraph
benjaoming 5d6e55c
Update title to reflect contents better, add additional entry in deve…
benjaoming d650294
Apply suggestions from code review
benjaoming f75075f
Add Traffic Analytics to the Main Features page
benjaoming a79593d
Remove How-to from Features
benjaoming dcc7954
Merge branch 'diataxis/main' of github.com:readthedocs/readthedocs.or…
benjaoming 38a7ade
Add a new Reference / Features section and create a stub for Search A…
benjaoming 5b0dd6c
Merge branch 'diataxis/main' of github.com:readthedocs/readthedocs.or…
benjaoming d314006
Update screenshot and add more guidance to using the search analytics…
benjaoming f75dd43
Clarify "Daily search totals"
benjaoming d823f0c
Clarify what "Download all data" does
benjaoming a3f04f8
Update docs/user/reference/analytics.rst
benjaoming 0b9b5a9
Rm trailing whitespace
benjaoming 1abc04f
Apply sentence case for titles
benjaoming a1d46c7
Apply suggestions from code review @ericholscher
benjaoming d300a3b
Merge branch 'diataxis/main' of github.com:readthedocs/readthedocs.or…
benjaoming b30c7fa
Merge branch 'diataxis/traffic-analytics-howto' of github.com:benjaom…
benjaoming fdf2712
Fix white-space lint
benjaoming File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
Analytics for Search and Traffic | ||
benjaoming marked this conversation as resolved.
Show resolved
Hide resolved
|
||
================================ | ||
|
||
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 | ||
benjaoming marked this conversation as resolved.
Show resolved
Hide resolved
|
||
----------------- | ||
|
||
Read the Docs aggregates simple statistics about visits to your documentation. | ||
benjaoming marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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. | ||
benjaoming marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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. | ||
benjaoming marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
======== | ||
Features | ||
benjaoming marked this conversation as resolved.
Show resolved
Hide resolved
|
||
======== | ||
|
||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
analytics |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.