Skip to content

Commit

Permalink
Fix analytics links (#11661)
Browse files Browse the repository at this point in the history
* Fix analytics links

Not sure how these didn't break the build..

* Fix other issues

* Clean up index
  • Loading branch information
ericholscher authored Oct 14, 2024
1 parent ca9b658 commit 09e36f0
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 16 deletions.
3 changes: 0 additions & 3 deletions docs/user/addons.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ Read the Docs Addons

**Read the Docs Addons** is a group of features for documentation readers and maintainers that you can add to any documentation set hosted on Read the Docs:

:doc:`Traffic analytics </analytics>`
explore pageviews for your docs

:doc:`DocDiff </pull-requests>`
highlight changed output from pull requests

Expand Down
4 changes: 2 additions & 2 deletions docs/user/commercial/sharing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Authenticated redirect
If you want to share documentation with a group of users,
you need to authenticate those users against your own system first.
The simplest way to do this is to create an authenticated redirect on your site,
which then redirects to the Read the Docs :ref:`Secret link`.
which then redirects to the Read the Docs :ref:`commercial/sharing:secret link`.

This should require very little customization,
and will ensure that only authenticated users can access the documentation.
Expand All @@ -134,7 +134,7 @@ and then proxies the request to Read the Docs.
This is more complex to set up,
but will allow users to access the documentation directly from a bookmark,

This approach would use a :ref:`HTTP Authorization Header` to authenticate users,
This approach would use a :ref:`commercial/sharing:HTTP Authorization Header` to authenticate users,
and would be configured in your proxy server.

Proxy example
Expand Down
4 changes: 2 additions & 2 deletions docs/user/guides/content/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ How-to guides: content, themes and SEO
This article explains how documentation can be optimized to appear in search results,
ultimately increasing traffic to your docs.

⏩️ :doc:`Using traffic analytics </analytics>`
⏩️ :doc:`Using traffic analytics </traffic-analytics>`
In this guide, you can learn to use Read the Docs' built-in traffic analytics for your documentation project.

⏩️ :doc:`Managing translations for Sphinx projects </guides/manage-translations-sphinx>`
Expand Down Expand Up @@ -57,7 +57,7 @@ How-to guides: content, themes and SEO
:hidden:

Search engine optimization (SEO) for documentation projects </guides/technical-docs-seo-guide>
Using traffic analytics </analytics>
Using traffic analytics </traffic-analytics>
Using search analytics </search-analytics>
Enabling offline formats </guides/enable-offline-formats>
Embedding content from your documentation </guides/embedding-content>
Expand Down
2 changes: 1 addition & 1 deletion docs/user/guides/technical-docs-seo-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -320,7 +320,7 @@ Analytics tools
~~~~~~~~~~~~~~~

A tool like Google Analytics,
along with our :doc:`integrated Read the Docs analytics </analytics>`,
along with our :doc:`integrated Read the Docs analytics </traffic-analytics>`,
can give you feedback about the search terms people use to find your docs,
your most popular pages, and lots of other useful data.

Expand Down
12 changes: 5 additions & 7 deletions docs/user/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,12 @@ Read the Docs: documentation simplified
:hidden:
:caption: Business features

/commercial/index
/commercial/organizations
/commercial/single-sign-on
/commercial/sharing
/commercial/subscriptions
/commercial/privacy-levels
/commercial/privacy-level

.. toctree::
:maxdepth: 2
Expand Down Expand Up @@ -222,15 +223,15 @@ Business features

Features for organizations and businesses:

:doc:`/commercial/index`
Learn more about our commercial features.

:doc:`/commercial/organizations`
Learn how to manage your organization on Read the Docs.

:doc:`/commercial/single-sign-on`
Learn how to use single sign-on with Read the Docs.

:doc:`/commercial/sharing`
Learn how to share your documentation with others.

How-to guides
-------------

Expand All @@ -239,9 +240,6 @@ Step-by-step guides for common tasks:
:doc:`/guides/pull-requests`
Setup pull request builds and enjoy previews of each commit.

:doc:`/analytics`
Learn more about how users are interacting with your documentation.

:doc:`/guides/cross-referencing-with-sphinx`
Learn how to use cross-references in a Sphinx project.

Expand Down
2 changes: 1 addition & 1 deletion docs/user/tutorial/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -527,7 +527,7 @@ Understanding traffic analytics

The Traffic Analytics view gives you a simple overview of how your readers browse your documentation. It respects visitor privacy by not storing identifying information about your them.

The :doc:`/analytics` view shows the top viewed documentation pages of the past 30 days,
This page shows the most viewed documentation pages of the past 30 days,
plus a visualization of the daily views during that period.

To see the Traffic Analytics view, go back the :term:`project page` again,
Expand Down

0 comments on commit 09e36f0

Please sign in to comment.