fix: point OpenShift documentation links at docs.redhat.com - #217
Open
arska wants to merge 1 commit into
Open
Conversation
docs.openshift.com is a legacy domain. Every link to it now takes four
redirects, two of which downgrade to plain HTTP, before landing on Red Hat's
current documentation site:
https://docs.openshift.com/container-platform/
-> http://docs.openshift.com/container-platform/latest (301, downgrade)
-> http://docs.openshift.com/container-platform/4.18/ (301)
-> https://docs.openshift.com/container-platform/4.18/ (301, back up)
-> http://docs.openshift.com/.../welcome/index.html (301, down again)
-> https://docs.redhat.com/en/documentation/openshift_container_platform/...
Linking the destination removes the chain, the protocol downgrades, and a
version pin nobody chose: the bare /container-platform/ URL resolves to
whichever version Red Hat currently redirects to, which is 4.18 today.
13 occurrences across 9 files. Each replacement is where Red Hat's own redirect
resolves that exact URL today, so the mapping is theirs rather than mine, with
three exceptions checked in a browser instead:
- The bare /container-platform/ link resolves to 4.18/html/about/welcome-index,
but that book no longer exists at `latest` (404 on 4.22). It now points at the
product landing page, which stays current.
- The 4.11 ServiceMonitor API page is gone; Red Hat's redirect gives up at the
4.11 version root. It now points at the same page under `latest`.
- Links that said `latest` still say `latest`. docs.redhat.com honours the same
alias, so nothing is newly pinned.
Version-pinned links keep their version (3.11, 4.8, 4.9, 4.11), except the one
above whose page no longer exists at that version. Whether those versions are
still the right ones to document against is a separate editorial question and is
deliberately not touched here.
One anchor is dropped: accessing-the-registry.html#prerequisites has no
corresponding fragment on the new page.
Found by the external link audit in vshn/landingpager#707, which reported the
two occurrences on index.adoc. The other 11 are the same problem on pages that
audit does not reach.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs.openshift.com is a legacy domain with a four-hop redirect chain
Every link to it now goes through four redirects, two of which downgrade to plain HTTP, before reaching Red Hat's current documentation site:
Linking the destination removes the chain, the protocol downgrades, and a version pin nobody chose: the bare
/container-platform/URL resolves to whatever Red Hat currently points it at, which is 4.18 today and will silently change.13 occurrences across 9 files. The pages still render the same; only the hrefs change.
Where the replacements come from
Each one is where Red Hat's own redirect resolves that exact URL today, so the mapping is theirs rather than mine. Three needed a judgment call instead, and each was checked in a browser rather than guessed:
/container-platform/4.18/html/about/welcome-index, but that book 404s atlatest(checked on 4.22).../openshift_container_platform/latestlatest, verified livelatestdocs.redhat.comhonours the same aliaslatest, so nothing is newly pinnedI originally tried to verify all 13 targets with a script, using "does it redirect?" as the signal for a valid page. That check was worthless:
docs.redhat.comanswers 403 to every non-browser client regardless of user agent, and my known-dead control passed it exactly like the known-good one. The browser checks above are what the three judgment calls actually rest on.Deliberately not changed
accessing-the-registry.html#prerequisiteshas no corresponding fragment on the new page, so it lands at the top of the right chapter.How it was found
The external link audit in
vshn/landingpager#707flagged the two occurrences onindex.adocas 403s. They are not dead links:docs.redhat.comblocks non-browser clients below the user-agent level, and the pages load fine in a browser. Excluding the domain from the link checker would have been the easy answer and would have left the redirect chain, the HTTP downgrades and the drifting version pin in place. The other 11 occurrences are the same problem on pages that audit does not reach.