readthedocs.org
readthedocs.org copied to clipboard
Move docs to `docs.readthedocs.com`
There's a few questions here:
- Do we keep
devatreadthedocs.io? Seems reasonable to start. - Do we do it at
docs.readthedocs.com? That seems to be where we're standardizing (eg.about.)
Do we do it at
docs.readthedocs.com? That seems to be where we're standardizing (eg.about.)
What the reason behind this domain change? Is it marketing? Is it SEO? Is it standardization?
@humitos mostly to reduce user confusion on the official-ness of the docs, with SEO & marketing as secondary benefits.
I went ahead and added this as a custom domain to our main docs, so the URL will work. If we want to move forward with it, we can set it as canonical, which should cause the old URLs to redirect.
Hrm, looks like this broke the flyout, as it's not doing a request to the addons URLs.. I wonder if it's because it's hosted on readthedocs.com or similar, will need to debug it.
I just created a Domain for our existing docs.readthedocs.io project:
docs.readthedocs.com. 300 IN CNAME readthedocs.io.
looks like this broke the flyout, as it's not doing a request to the addons URLs
The readthedocs-addons.js file is not being injected by CF and the readthedocs-doc-embed.[js|css] files are not being removed for some reason. I'm debugging this more to see if I find something useful.
I found the issue. Since we have registered readthedocs.com in our CF platform as well it needs a special Worker Route. I added the special router and it works now. I opened a PR for this at https://github.com/readthedocs/readthedocs-ops/pull/1498
Next step here is putting together a public landing page.
Got our dev docs moved over to the new docs.readthedocs.com domain: https://docs.readthedocs.com/dev/latest/
Next up is the product docs, but waiting a couple days to see if we hit any issues w/ the dev redirects.
@ericholscher If you changed something in the CF console, remember to make those changes in TF as well.
This is close, but is blocked on redirects. We have a lot of redirects on our project now. Also maybe try readthedocs-cli for bulk edits of redirects (I think)
This is now done! 🎉
The fancy new docs are here: https://docs.readthedocs.com/platform/stable/