chore: Update GitHub pages to redirect to readthedocs

[jmeridth]

Previously was #12212

Relates to #12360

Motivation

Change each GitHub page to utilize meta tag to redirect to new location on readthedocs

Since we don't host our previous documentation we can't do a real HTTP redirect. Meta tag is the next best thing

https://www.w3.org/TR/WCAG20-TECHS/H76.html

Modifications

• setup redirects to readthedocs + previus page suffix (once chore: move documentation to readthedocs #12360 merges and builds)

Python script used to update the files

[juliev0]

so, is it through these html files that people will mainly be getting to the documentation now? or only in the case that they're looking for a specific version of the documentation, and if not through a redirect from https://argoproj.github.io/argo-workflows?

[juliev0]

so, is it through these html files that people will mainly be getting to the documentation now? or only in the case that they're looking for a specific version of the documentation, and if not through a redirect from https://argoproj.github.io/argo-workflows?

Actually, I guess the redirect takes one to "stable" - so that implies that if someone navigated to one of these files within a given Github release tag, they would not be redirected to readthedocs for that version, right?

[jmeridth]

@juliev0 these redirects will ensure people get to the new docs location and to the files they had old links to. Great catch on stable vs latest. Links fixed. By redirecting users to latest (which is what we will set main readthedocs builds to), they will have the same effect users had previously.

[juliev0]

@juliev0 these redirects will ensure people get to the new docs location and to the files they had old links to. Great catch on stable vs latest. Links fixed. By redirecting users to latest (which is what we will set main readthedocs builds to), they will have the same effect users had previously.

So, it looks like we no longer publish to https://argoproj.github.io/argo-workflows? Will there be any redirect from there or no?

[juliev0]

@juliev0 these redirects will ensure people get to the new docs location and to the files they had old links to. Great catch on stable vs latest. Links fixed. By redirecting users to latest (which is what we will set main readthedocs builds to), they will have the same effect users had previously.

So, it looks like we no longer publish to https://argoproj.github.io/argo-workflows? Will there be any redirect from there or no?

Oh, never mind. These index.html pages are still being published to https://argoproj.github.io/argo-workflows, aren't they?

[jmeridth]

@juliev0 yes, they'd replace the github pages and still be published.

[juliev0]

Let me know if this is an unreasonable request, but would it make any sense to attach the script you used to make the change as something that could be reviewed instead of trying to review all of the docs?

[jmeridth]

@juliev0 https://gist.github.com/jmeridth/94cd15d2b11d444fdf91913aa59f34ab (please don't judge 😉, was written in under an hour)

[agilgur5]

Thanks for modifying these all! Looks like you got nearly everything; I was checking for subdirs in particular and you got all the ones I checked.

I left a few comments in-line for some improvements and/or missing pieces

[jmeridth]

@agilgur5 as these updates are generated from my script (updated with your latest suggestions), I am running locally and pushing. Don't mean to not give credit for the contributions, suggestions. You cool with me adding you as a co-author?

[agilgur5]

nbd, I don't really mind either way. thanks for asking though!

[juliev0]

@juliev0 https://gist.github.com/jmeridth/94cd15d2b11d444fdf91913aa59f34ab (please don't judge 😉, was written in under an hour)

Really appreciate your doing that, even though I know it's an unusual request!

[agilgur5]

Two small corrections, otherwise LGTM

[agilgur5]

LGTM, thanks for automating all the redirects and iterating on this!

[agilgur5]

One tiny thing I noticed, that I don't think we can really do much about, is that URL anchor will be lost in the redirect. I.e. if you had some-link#some-section, the anchor #some-section will be lost.

But adding the anchor requires front-end JS or back-end logic. We have no back-end in GH Pages and the meta redirect is the closest thing, but can't pick up arbitrary anchors in the URL.
A really wacky workaround may be to use JS to insert a meta tag into the page, but idk if that will work properly.

EDIT: interestingly, the mkdocs-redirects plugin uses both a meta tag and a JS script. See #12501

[terrytangyuan]

Did you mean to mark this as ready for review?

[jmeridth]

Did you mean to mark this as ready for review?

Yes for review but #12360 has to merge first. I'm ready to move on both.

[jmeridth]

Don't know why this closed. @terrytangyuan are you able to reopen?

[terrytangyuan]

Did you recreate the branch with the same name and force pushed? That might be why. Not 100% sure though.

[terrytangyuan]

I cannot re-open it somehow

[jmeridth]

Did you recreate the branch with the same name and force pushed? That might be why. Not 100% sure though.

Yeah, had to. Let me see if I can do it the other way. One sec.

[jmeridth]

New PR it is then. Dang it. Sorry.

[jmeridth]

Replaced by #12443