docs: fix versioned docs links#537
Conversation
Signed-off-by: Avinash Kumar Deepak <[email protected]>
volcano-sh-bot
added
the
kind/documentation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Welcome @avinxshKD! It looks like this is your first PR to volcano-sh/website 🎉 |
volcano-sh-bot
added
the
size/M
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates broken, absolute, and outdated documentation links across multiple versions of the Volcano documentation (v1.7.0 through v1.12.0) to use relative paths, external GitHub links, or plain text. The reviewer pointed out that some of the updated links in QueueResourceManagement.md for versions v1.11.0 and v1.12.0 are self-referencing and should be simplified to plain text to avoid redundancy.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
|
Hey @JesseStutler @kevin-wangzefeng @yashisrani Found a few stale links in older versioned docs that still pointed to /docs/..., which sends readers back to Latest. Pls have a look. |
Signed-off-by: Avinash Kumar Deepak <[email protected]>
| > **Note**: | ||
| > | ||
| > 1. This field can only be configured when the capacity plugin is enabled, and must be less than or equal to the capability value. The proportion plugin uses weight to automatically calculate the queue's deserved value. For more information on using the capacity plugin, see: [capacity plugin user guide](/docs/UserGuide/user_guide_how_to_use_capacity_plugin) | ||
| > 1. This field can only be configured when the capacity plugin is enabled, and must be less than or equal to the capability value. The proportion plugin uses weight to automatically calculate the queue's deserved value. For more information on using the capacity plugin, see: [capacity plugin user guide](https://github.com/volcano-sh/volcano/blob/v1.10.0/docs/user-guide/how_to_use_capacity_plugin.md) |
There was a problem hiding this comment.
Quite confused, at least it should link to the user guide for the same version v1.10.0, we currently have a User guide section, not linking to GitHub
| * parent, *optional* | ||
|
|
||
| This field is used to configure [hierarchical queues](/docs/KeyFeatures/HierarchicalQueue). parent specifies the parent queue. If parent is not specified, the queue will be set as a child queue of the root queue by default. | ||
| This field is used to configure hierarchical queues. parent specifies the parent queue. If parent is not specified, the queue will be set as a child queue of the root queue by default. |
There was a problem hiding this comment.
Why remove the link? We have such docs under the key featuers, just link to the same version
There was a problem hiding this comment.
Same here. This version snapshot does not have the KeyFeatures page, so a same-version relative link would be unresolved. Kept it as plain text to avoid jumping to Latest.
Signed-off-by: Avinash Kumar Deepak <[email protected]>
|
Hey @JesseStutler, checked this again. The page exists in latest docs, but not in the v1.10.0 versioned snapshot. Linking to /docs/... sends users back to Latest, and a relative link would be unresolved for this version. I updated it to plain text here to avoid both cases. If you prefer adding the missing docs to this version snapshot, I can do that too. |
3 participants
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
/kind documentation
/kind bug
What this PR does / why we need it:
Fixes stale links in older versioned docs that pointed to
/docs/....Those links send users back to Latest docs instead of keeping them in the selected version. Existing same-version pages now use relative links. Links with no matching page in that old version are left as plain text.
Fixes #536