docs: fix broken relative links - #5120
Open
wuallen57730 wants to merge 1 commit into
Open
Conversation
Signed-off-by: wuallen57730 <yuwu11926@gmail.com>
Author
|
PTAL when you have a chance, thanks! cc @andrewsykim @rueian |
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.
Why are these changes needed?
Five relative Markdown links in the docs don't resolve:
docs/development/release.mdpoints at./helm-chart.md, but the file is atdocs/release/helm-chart.md.docs/guidance/rayclient-nginx-ingress.mdpoints attls.md, which doesn't exist in this repo; the TLS guide now lives in the Ray docs.apiserver/README.mdare missing thehttp://scheme, so they render as relative paths.apiserver/DEVELOPMENT.mdalready writes the same two URLs correctly.apiserver/SecuringImplementation.mdlinks to../experimental/cmd/main.go, which was removed in delete unused experimental folder #4890. This was the last remaining reference to that folder.apiserver/DEVELOPMENT.mdlinks toswagger-initializer.js.backup, which is generated byhack/update-swagger-ui.bashand is gitignored, so it is never in the tree. Changed to an inline code span.Found by scanning every
.mdfile for relative links that don't resolve.Related issue number
N/A — doc link cleanup.
Labels
doc-updates-requiredlabel.breaking-changelabel.Checks
Manual test instructions
Verified each link resolves after the change, and re-ran the relative-link scan over all
.mdfiles.