Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Docs: Mention $READTHEDOCS_CANONICAL_URL #10246

Closed
benjaoming opened this issue Apr 17, 2023 · 0 comments · Fixed by #11516
Closed

Docs: Mention $READTHEDOCS_CANONICAL_URL #10246

benjaoming opened this issue Apr 17, 2023 · 0 comments · Fixed by #11516
Labels
Accepted Accepted issue on our roadmap Needed: documentation Documentation is required

Comments

@benjaoming
Copy link
Contributor

benjaoming commented Apr 17, 2023 •
edited
Loading

We have a howto guide about Canonical URLs which currently doesn't mention $READTHEDOCS_CANONICAL_URL:

https://docs.readthedocs.io/en/stable/guides/canonical-urls.html

It gets tricky with MkDocs, though - and we don't have a solution yet for #8529

image

Related: #10226
@benjaoming benjaoming added Needed: documentation Documentation is required Accepted Accepted issue on our roadmap labels Apr 17, 2023
@github-project-automation github-project-automation bot moved this to Planned in 📍Roadmap Apr 17, 2023
@benjaoming benjaoming changed the title Docs: Mention $READTHEDOCS_CANONICAL_URL and remove WIP note Docs: Mention $READTHEDOCS_CANONICAL_URL Apr 17, 2023
@humitos humitos mentioned this issue Nov 7, 2023
Closed
@amotl amotl mentioned this issue May 6, 2024
Closed
humitos added a commit that referenced this issue Aug 6, 2024
@humitos
Docs: remove "Canonical URLs" guide
de3fff5 
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
@humitos humitos mentioned this issue Aug 6, 2024
Merged
@github-project-automation github-project-automation bot moved this from Planned to Done in 📍Roadmap Aug 12, 2024
@github-project-automation github-project-automation bot moved this from Planned to Done in 📍Roadmap Aug 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Accepted Accepted issue on our roadmap Needed: documentation Documentation is required
Projects
📍Roadmap
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Docs: remove "Canonical URLs" guide readthedocs/readthedocs.org
1 participant
@benjaoming