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.

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

Document how canonical domains work #8469

Closed
humitos opened this issue Sep 7, 2021 · 3 comments
Closed

Document how canonical domains work #8469

humitos opened this issue Sep 7, 2021 · 3 comments
Assignees
Labels
Accepted Accepted issue on our roadmap Needed: documentation Documentation is required

Comments

@humitos
Copy link
Member

humitos commented Sep 7, 2021

We have implemented the redirects on canonical domains (I didn't find the PR). In this comment, we mentioned how they work #8250 (comment). However, our documentation doesn't explain how canonical domains work and nor their redirects

We should update our documentation to reflect this because it's generating confusion to our users.

@humitos humitos added Needed: documentation Documentation is required Accepted Accepted issue on our roadmap labels Sep 7, 2021
@humitos
Copy link
Member Author

humitos commented Jul 11, 2022

When working on this issue, we need to mention that it's required to re-build old versions when the Canonical URL is updated (from #8533 (comment))

@stsewd
Copy link
Member

stsewd commented Jul 11, 2022

That is already mentioned in the page https://docs.readthedocs.io/en/stable/canonical-urls.html.

@benjaoming
Copy link
Contributor

From the issue description:

However, our documentation doesn't explain how canonical domains work and nor their redirects

Now since #9676, the docs explain:

Your documentation can have multiple secondary domains but only one canonical domain name. Additional domains or subdomains will redirect to the canonical domain.

I believe this should be sufficient. But please LMK if you had something else in mind 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Needed: documentation Documentation is required
Projects
None yet
Development

No branches or pull requests

3 participants