From 23f8302e8a030ac7028793673e420d1d33eaf3aa Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Tue, 8 Oct 2024 13:48:10 -0700 Subject: [PATCH 1/3] Fix analytics links Not sure how these didn't break the build.. --- docs/user/addons.rst | 3 --- docs/user/guides/content/index.rst | 4 ++-- docs/user/guides/technical-docs-seo-guide.rst | 2 +- docs/user/index.rst | 3 --- docs/user/tutorial/index.rst | 2 +- 5 files changed, 4 insertions(+), 10 deletions(-) diff --git a/docs/user/addons.rst b/docs/user/addons.rst index 1468b24df50..225aed41191 100644 --- a/docs/user/addons.rst +++ b/docs/user/addons.rst @@ -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 ` - explore pageviews for your docs - :doc:`DocDiff ` highlight changed output from pull requests diff --git a/docs/user/guides/content/index.rst b/docs/user/guides/content/index.rst index 7e28cf39d29..6a37f61ae48 100644 --- a/docs/user/guides/content/index.rst +++ b/docs/user/guides/content/index.rst @@ -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 ` +⏩️ :doc:`Using 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 ` @@ -57,7 +57,7 @@ How-to guides: content, themes and SEO :hidden: Search engine optimization (SEO) for documentation projects - Using traffic analytics + Using traffic analytics Using search analytics Enabling offline formats Embedding content from your documentation diff --git a/docs/user/guides/technical-docs-seo-guide.rst b/docs/user/guides/technical-docs-seo-guide.rst index a8f1f7e7a5a..df595ee3dd7 100644 --- a/docs/user/guides/technical-docs-seo-guide.rst +++ b/docs/user/guides/technical-docs-seo-guide.rst @@ -320,7 +320,7 @@ Analytics tools ~~~~~~~~~~~~~~~ A tool like Google Analytics, -along with our :doc:`integrated Read the Docs analytics `, +along with our :doc:`integrated Read the Docs 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. diff --git a/docs/user/index.rst b/docs/user/index.rst index 020874322e5..97b7473c955 100644 --- a/docs/user/index.rst +++ b/docs/user/index.rst @@ -239,9 +239,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. diff --git a/docs/user/tutorial/index.rst b/docs/user/tutorial/index.rst index abae02b9c92..040fa720271 100644 --- a/docs/user/tutorial/index.rst +++ b/docs/user/tutorial/index.rst @@ -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, From 39c9e215549fff7287dd1cc6b05a53d0f1dbcbbe Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Tue, 8 Oct 2024 13:56:47 -0700 Subject: [PATCH 2/3] Fix other issues --- docs/user/commercial/index.rst | 2 ++ docs/user/commercial/sharing.rst | 4 ++-- docs/user/index.rst | 2 +- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/user/commercial/index.rst b/docs/user/commercial/index.rst index 8107d0f6ef8..f9a8a994f9e 100644 --- a/docs/user/commercial/index.rst +++ b/docs/user/commercial/index.rst @@ -1,3 +1,5 @@ +:orphan: + Business hosting ================ diff --git a/docs/user/commercial/sharing.rst b/docs/user/commercial/sharing.rst index 28ccc5eacb0..f17d975c1a6 100644 --- a/docs/user/commercial/sharing.rst +++ b/docs/user/commercial/sharing.rst @@ -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. @@ -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 diff --git a/docs/user/index.rst b/docs/user/index.rst index 97b7473c955..aa88adc4d8c 100644 --- a/docs/user/index.rst +++ b/docs/user/index.rst @@ -87,7 +87,7 @@ Read the Docs: documentation simplified /commercial/single-sign-on /commercial/sharing /commercial/subscriptions - /commercial/privacy-levels + /commercial/privacy-level .. toctree:: :maxdepth: 2 From 9f5513e4350d8070a0b89ae54c1edf1690be0954 Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Tue, 8 Oct 2024 13:57:53 -0700 Subject: [PATCH 3/3] Clean up index --- docs/user/commercial/index.rst | 2 -- docs/user/index.rst | 7 ++++--- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/user/commercial/index.rst b/docs/user/commercial/index.rst index f9a8a994f9e..8107d0f6ef8 100644 --- a/docs/user/commercial/index.rst +++ b/docs/user/commercial/index.rst @@ -1,5 +1,3 @@ -:orphan: - Business hosting ================ diff --git a/docs/user/index.rst b/docs/user/index.rst index aa88adc4d8c..3a866261a88 100644 --- a/docs/user/index.rst +++ b/docs/user/index.rst @@ -83,6 +83,7 @@ Read the Docs: documentation simplified :hidden: :caption: Business features + /commercial/index /commercial/organizations /commercial/single-sign-on /commercial/sharing @@ -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 -------------