Skip to content

Commit

Permalink
Docs: remove "Canonical URLs" guide (#11516)
Browse files Browse the repository at this point in the history
This guide is pretty old and it's not correct anymore.
Besides, we are now mentioning `$READTHEDOCS_CANONICAL_URL` environment variable
in the https://docs.readthedocs.io/en/stable/canonical-urls.html.

We should create a redirect from the page deleted to that one where we are
already mentioning how to configure Sphinx and MkDocs.

Closes #10246
  • Loading branch information
humitos authored Aug 12, 2024
1 parent 346cc82 commit 1b14f65
Show file tree
Hide file tree
Showing 4 changed files with 1 addition and 68 deletions.
5 changes: 0 additions & 5 deletions docs/user/canonical-urls.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,6 @@ and this is one of the suggested ways to solve it from search engines.

.. _canonical URL: https://developers.google.com/search/docs/advanced/crawling/consolidate-duplicate-urls

.. seealso::

:doc:`/guides/canonical-urls`
More information on how to enable canonical URLs in your project.

How Read the Docs generates canonical URLs
------------------------------------------

Expand Down
58 changes: 0 additions & 58 deletions docs/user/guides/canonical-urls.rst

This file was deleted.

4 changes: 0 additions & 4 deletions docs/user/guides/content/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ 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:`Enabling canonical URLs </guides/canonical-urls>`
In this guide, we introduce relevant settings for enabling canonical URLs in popular documentation frameworks.

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

Expand Down Expand Up @@ -62,7 +59,6 @@ How-to guides: content, themes and SEO
Search engine optimization (SEO) for documentation projects </guides/technical-docs-seo-guide>
Using traffic analytics </analytics>
Using search analytics </guides/search-analytics>
Enabling canonical URLs </guides/canonical-urls>
Enabling offline formats </guides/enable-offline-formats>
Embedding content from your documentation </guides/embedding-content>
Managing translations for Sphinx projects </guides/manage-translations-sphinx>
Expand Down
2 changes: 1 addition & 1 deletion docs/user/reference/404-not-found.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ We have examples for some of the most popular tools below.

MkDocs automatically generates a ``404.html`` which Read the Docs will use.
However, assets will not be loaded correctly unless you define the `site_url`_ configuration value as your site's
:ref:`canonical base URL <guides/canonical-urls:MkDocs>`.
:doc:`canonical base URL </canonical-urls>`.

.. _sphinx-notfound-page: https://pypi.org/project/sphinx-notfound-page
.. _html_extra_path: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_extra_path
Expand Down

0 comments on commit 1b14f65

Please sign in to comment.