docs: sync missing plugin documentation from volcano core repository

[hemantch01]

Please check if the PR fulfills these requirements

• The commit message follows our guidelines

• What kind of change does this PR introduce?
  /kind documentation

• What this PR does / why we need it:
  This PR synchronizes the website documentation with the current features available in the main volcano-sh/volcano repository. Currently, several active plugins in the core codebase lack proper user guides, creating a gap for users attempting to discover or configure these features.

This update introduces detailed documentation for differnt plugins:

• Scheduler Plugins: usage, rescheduling, resourcequota, pdb, overcommit, and deviceshare.
• Job Plugin: hcclrank.

Things done so far

• Added New Plugins Documentation
• Refactored Documentation Structure (separated plugins into Scheduler and Controller directories)
• Added Chinese (zh-Hans) Fallbacks *(todo: add chinese translation for next pr)
• Fixed Sidebar to make more accessible
• Fixed Broken Markdown Links
• Fixed SVG Image Warnings duing compile time
• 

Fixes #501

[volcano-sh-bot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign thor-wl for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[gemini-code-assist]

Code Review

This pull request introduces comprehensive documentation for several Volcano scheduler plugins, including DeviceShare, HCCLRank, Overcommit, Pod Disruption Budget (PDB), Rescheduling, ResourceQuota, and Usage-based scheduling. The feedback identifies necessary corrections in the Usage-based scheduling guide, specifically regarding the correct nesting of the 'enablePredicate' parameter within the 'arguments' block, the use of 'memory' instead of 'mem' for threshold keys to maintain consistency, and the correction of the metrics type string for the Prometheus Adaptor.

[gemini-code-assist]

The enablePredicate configuration should be placed within the arguments block of the plugin configuration to be correctly parsed by the Volcano scheduler. Additionally, the threshold key for memory is typically memory rather than mem to maintain consistency with other resource naming conventions in Volcano.

Suggested change

	- name: usage # usage based scheduling plugin
	enablePredicate: false # If false, new pod scheduling is not disabled when node load reaches the threshold. If true or empty, new pod scheduling is disabled.
	arguments:
	usage.weight: 5
	cpu.weight: 1
	memory.weight: 1
	thresholds:
	cpu: 80 # The node cannot schedule new pods if its actual CPU load reaches 80%.
	mem: 70 # The node cannot schedule new pods if its actual Memory load reaches 70%.
	- name: usage # usage based scheduling plugin
	arguments:
	enablePredicate: false # If false, new pod scheduling is not disabled when node load reaches the threshold. If true or empty, new pod scheduling is disabled.
	usage.weight: 5
	cpu.weight: 1
	memory.weight: 1
	thresholds:
	cpu: 80 # The node cannot schedule new pods if its actual CPU load reaches 80%.
	memory: 70 # The node cannot schedule new pods if its actual Memory load reaches 70%.

[gemini-code-assist]

The metrics type for the Prometheus Adaptor in Volcano is prometheus_adapt, not prometheus_adaptor. This matches the description provided in the configuration section on line 61.

Suggested change

	Set the metrics `type` in the scheduler configmap to `prometheus_adaptor`.
	Set the metrics `type` in the scheduler configmap to `prometheus_adapt`.

[hemantch01]

@JesseStutler

[Arhell]

/lgtm

[hemantch01]

hi @Arhell when i was setting up repo i faced the compatibility issue first so this needs to merge first #497 and this pr also adds syntax highlighting for yaml examples

[JesseStutler]

Thanks for your great work, but I prefer not to put plugins related docs under user guide, but to set the plugin as the second menu and then put all plugin related docs into it. We can first wait until #493 merged and then continue refactoring

[JesseStutler]

/hold

[hemantch01]

sure @JesseStutler i can do that once PR #493 gets merged.

[JesseStutler]

Wish you could refactor to plugins section under scheduler and plugins under controller section

[hemantch01]

i have done already i was just making the architecture diagram so in this pr i wll just raise refactor and will raise another for the diagram

[volcano-sh-bot]

New changes are detected. LGTM label has been removed.

[hemantch01]

hi @JesseStutler please check

[JesseStutler]

Could you explain why there are so many files changed?

[hemantch01]

yes sure this is the deployedLink and if you see files changed (mentioend in the github also) this is due to (moved files) + (new docs )*2 (same doc for english and chinese) otherwise getting error in chinese docs +(changed the sidebar positions) before this was messy + (metadata for the docusaurus) so that refactored sections can be shown correctly + then relative link for all the interconnected files changed.
and relative links were changed in each and every version of volcano

[JesseStutler]

yes sure this is the deployedLink and if you see files changed (mentioend in the github also) this is due to (moved files) + (new docs )*2 (same doc for english and chinese) otherwise getting error in chinese docs +(changed the sidebar positions) before this was messy + (metadata for the docusaurus) so that refactored sections can be shown correctly + then relative link for all the interconnected files changed. and relative links were changed in each and every version of volcano

Shouldn't this PR only to add plugin docs for the website? I don't get why you changed some many files

[hemantch01]

Wish you could refactor to plugins section under scheduler and plugins under controller section

you told me to refactor it?? the added docs are not that much, but refactor and then changing relative links for many eng+ chinese and for all the versions, if you want i can move refactor part in another pr also.

[hemantch01]

Wish you could refactor to plugins section under scheduler and plugins under controller section

you told me to refactor it?? the added docs are not that much, but refactor and then changing relative links for many eng+ chinese and for all the versions, if you want i can move refactor part in another pr also.

hi @JesseStutler ??

[JesseStutler]

Cool, will take a look

[JesseStutler]

One sentence is a bit thin for what is now the landing page of the Controller section. Could you expand this a little — e.g. what the Job Controller actually reconciles (Job, PodGroup, tasks, lifecycle policies), how plugins hook into it (OnJobAdd / OnPodCreate / etc.), and a short index linking to each plugin page under ./Plugins/ (env, ssh, svc, tensorflow, mpi, pytorch, ray, hcclrank).

Also worth noting for a follow-up: the Controller section can later host a Policies page too (the lifecycle policies on Job/Task, e.g. PodEvicted / TaskCompleted / TaskFailed actions). No need to include that in this PR, just calling it out so we have a slot for it.

Same expansion needed on the matching i18n/zh-Hans/.../Controller/Overview.md.

[hemantch01]

i will be adding picture and more description, but this pr is getting too long so i will fix it in next pr. or i can add in this pr your call.

[hemantch01]

hi @JesseStutler i have addressed the comments, so most of the comments were to be fixed by me without asking your opinion and i did but i need your opinion on this comment below.
for the quoted comment below:
i will be adding picture and more description for controller main page, but this pr is getting too long so i will fix it in next pr.

One sentence is a bit thin for what is now the landing page of the Controller section. Could you expand this a little — e.g. what the Job Controller actually reconciles (Job, PodGroup, tasks, lifecycle policies), how plugins hook into it (OnJobAdd / OnPodCreate / etc.), and a short index linking to each plugin page under ./Plugins/ (env, ssh, svc, tensorflow, mpi, pytorch, ray, hcclrank).

Also worth noting for a follow-up: the Controller section can later host a Policies page too (the lifecycle policies on Job/Task, e.g. PodEvicted / TaskCompleted / TaskFailed actions). No need to include that in this PR, just calling it out so we have a slot for it.

Same expansion needed on the matching i18n/zh-Hans/.../Controller/Overview.md.

other comments are marked resolved by me, only this is left.
also diff is (diff) * 2 As i had to change in both chinese and english.

[hemantch01]

hi @JesseStutler i have addressed the comments, so most of the comments were to be fixed by me without asking your opinion and i did but i need your opinion on this comment below. for the quoted comment below: i will be adding picture and more description for controller main page, but this pr is getting too long so i will fix it in next pr.

One sentence is a bit thin for what is now the landing page of the Controller section. Could you expand this a little — e.g. what the Job Controller actually reconciles (Job, PodGroup, tasks, lifecycle policies), how plugins hook into it (OnJobAdd / OnPodCreate / etc.), and a short index linking to each plugin page under ./Plugins/ (env, ssh, svc, tensorflow, mpi, pytorch, ray, hcclrank).
Also worth noting for a follow-up: the Controller section can later host a Policies page too (the lifecycle policies on Job/Task, e.g. PodEvicted / TaskCompleted / TaskFailed actions). No need to include that in this PR, just calling it out so we have a slot for it.
Same expansion needed on the matching i18n/zh-Hans/.../Controller/Overview.md.

other comments are marked resolved by me, only this is left. also diff is (diff) * 2 As i had to change in both chinese and english.

hi @JesseStutler ??