search

readthedocs / readthedocs.org

The source code that powers readthedocs.org
https://readthedocs.org/
MIT License
8.03k stars 3.58k forks source link

Move docs to `docs.readthedocs.com` #10094

Open ericholscher opened 1 year ago

ericholscher commented 1 year ago

There's a few questions here:

humitos commented 1 year ago

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?

ericholscher commented 1 year ago

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

ericholscher commented 4 months ago

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 commented 4 months ago

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.
humitos commented 4 months ago

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 commented 4 months ago

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

ericholscher commented 2 months ago

Next step here is putting together a public landing page.