readthedocs.org icon indicating copy to clipboard operation
readthedocs.org copied to clipboard

Move docs to `docs.readthedocs.com`

Open ericholscher opened this issue 2 years ago • 7 comments

There's a few questions here:

  • Do we keep dev at readthedocs.io? Seems reasonable to start.
  • Do we do it at docs.readthedocs.com? That seems to be where we're standardizing (eg. about.)

ericholscher avatar Mar 01 '23 17:03 ericholscher

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 avatar Mar 01 '23 20:03 humitos

@humitos mostly to reduce user confusion on the official-ness of the docs, with SEO & marketing as secondary benefits.

ericholscher avatar Mar 01 '23 20:03 ericholscher

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.

ericholscher avatar Jun 18 '24 22:06 ericholscher

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.

ericholscher avatar Jun 19 '24 16:06 ericholscher

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.

humitos avatar Jun 20 '24 08:06 humitos

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

humitos avatar Jun 20 '24 08:06 humitos

Next step here is putting together a public landing page.

ericholscher avatar Jul 31 '24 17:07 ericholscher

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 avatar Nov 07 '24 21:11 ericholscher

@ericholscher If you changed something in the CF console, remember to make those changes in TF as well.

humitos avatar Nov 11 '24 11:11 humitos

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)

agjohnson avatar Nov 20 '24 17:11 agjohnson

This is now done! 🎉

The fancy new docs are here: https://docs.readthedocs.com/platform/stable/

ericholscher avatar Jan 24 '25 21:01 ericholscher