add user guide from main repository

[aniketchawardol]

• What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
  /kind documentation

• What this PR does / why we need it: This PR adds user-docs documentation from the main repository. All sections of user guide have been added and integrated with a dedicated User Guide Chapter. Conent has been formatted, images have been added, broken links have been fixed. (was searching for broken links and found that gpu-virtualization page also had broken installation guide links, updated them as well).

examples of formatting done:

Which issue(s) this PR fixes: #467

I think I was exceeding the limit for a manual review, hence I have currently added docs for the latest version only. User guides for older versions can be added later according to their compatibility.

[volcano-sh-bot]

Welcome @aniketchawardol! It looks like this is your first PR to volcano-sh/website 🎉

[gemini-code-assist]

Summary of Changes

Hello @aniketchawardol, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the Volcano documentation by introducing a new, dedicated 'User Guide' chapter. It consolidates and expands user-focused content, making it easier for users to understand and configure various aspects of the Volcano scheduler and its plugins. The update also includes a detailed performance tuning guide and general improvements to content presentation and link integrity.

Highlights

• New User Guide Section: A dedicated 'User Guide' section has been added to the documentation, providing a centralized and comprehensive resource for Volcano users.
• Comprehensive Plugin and Feature Guides: Detailed user guides have been integrated for various Volcano features and plugins, including Capacity, Cooldown Protection, Dynamic Resource Allocation (DRA), Env, Extender, GPU Number, GPU Sharing, HyperNode Auto Discovery, Job Policy, Job TTL, MPI, Network Topology Aware Scheduling, Nodegroup, NUMA Aware, Pytorch, Ray, Resource Strategy Fit, SSH, SVC, Ascend vNPU, and Volcano vGPU.
• Performance Tuning Guide: A new guide on tuning Volcano performance in large-scale scenarios has been added, detailing performance bottlenecks, experimental verification, and optimization solutions.
• Documentation Improvements: Content has been formatted, relevant images have been added, and broken links (including those in the existing GPU virtualization page) have been fixed across the documentation.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• config/_default/menus.toml
  • Added a new 'User Guide' entry to the documentation navigation menu.
• content/en/docs/user_guide.md
  • Created a new top-level user guide page to serve as an index for all specific user guides.
• content/en/docs/user_guide_how_to_configure_priorityclass_for_job.md
  • Added a new guide on configuring priority classes for Volcano jobs.
• content/en/docs/user_guide_how_to_configure_scheduler.md
  • Added a new guide explaining how to configure the Volcano scheduler's actions, tiers, and plugins.
• content/en/docs/user_guide_how_to_enable_dra.md
  • Added a new guide on enabling Dynamic Resource Allocation (DRA) in the Volcano scheduler.
• content/en/docs/user_guide_how_to_tune_volcano_performance.md
  • Added a detailed guide on tuning Volcano performance in large-scale scenarios, including bottleneck analysis and optimization solutions.
• content/en/docs/user_guide_how_to_use_capacity_plugin.md
  • Added a user guide for the Capacity plugin.
• content/en/docs/user_guide_how_to_use_cdp_plugin.md
  • Added a user guide for the Cooldown Protection plugin.
• content/en/docs/user_guide_how_to_use_env_plugin.md
  • Added a user guide for the Env plugin.
• content/en/docs/user_guide_how_to_use_extender.md
  • Added a user guide for the Extender plugin.
• content/en/docs/user_guide_how_to_use_gpu_number.md
  • Added a user guide for the GPU Number feature, noting its deprecation in v1.9.
• content/en/docs/user_guide_how_to_use_gpu_sharing.md
  • Added a user guide for the GPU Sharing feature, noting its deprecation in v1.9.
• content/en/docs/user_guide_how_to_use_hypernode_auto_discovery.md
  • Added a user guide for HyperNode Auto Discovery.
• content/en/docs/user_guide_how_to_use_job_policy.md
  • Added a user guide for Volcano Job Policies.
• content/en/docs/user_guide_how_to_use_job_ttl.md
  • Added a user guide for Volcano Job Time to Live (TTL).
• content/en/docs/user_guide_how_to_use_mpi_plugin.md
  • Added a user guide for the MPI plugin.
• content/en/docs/user_guide_how_to_use_network_topology_aware_scheduling.md
  • Added a user guide for Network Topology Aware Scheduling.
• content/en/docs/user_guide_how_to_use_nodegroup_plugin.md
  • Added a user guide for the Nodegroup plugin.
• content/en/docs/user_guide_how_to_use_numa_aware.md
  • Added a user guide for NUMA Aware scheduling.
• content/en/docs/user_guide_how_to_use_pytorch_plugin.md
  • Added a user guide for the Pytorch plugin.
• content/en/docs/user_guide_how_to_use_ray_plugin.md
  • Added a user guide for the Ray plugin.
• content/en/docs/user_guide_how_to_use_resource_strategy_fit_plugin.md
  • Added a user guide for the Resource Strategy Fit plugin.
• content/en/docs/user_guide_how_to_use_ssh_plugin.md
  • Added a user guide for the SSH plugin.
• content/en/docs/user_guide_how_to_use_svc_plugin.md
  • Added a user guide for the SVC plugin.
• content/en/docs/user_guide_how_to_use_vnpu.md
  • Added a user guide for Ascend vNPU.
• content/en/docs/user_guide_how_to_use_volcano_vgpu.md
  • Added a user guide for Volcano vGPU.
• content/en/docs/v1-11-0/gpu_virtualization.md
  • Updated broken installation guide links to point to the correct GitHub repository path.
• content/zh/docs/v1-11-0/gpu_virtualization.md
  • Updated broken installation guide links to point to the correct GitHub repository path in the Chinese documentation.

Activity

• aniketchawardol initiated this pull request to integrate user guide documentation from the main repository.
• The PR is classified as a documentation update, focusing on improving user-facing content.
• All sections of the user guide have been added and integrated into a dedicated 'User Guide' chapter.
• Content has been formatted, new images have been added, and broken links throughout the documentation have been fixed.
• The author noted that due to potential manual review limits, only documentation for the latest version was included, with older versions to be addressed later.
• This pull request addresses and fixes issue Synchronize Volcano User Guide from docs to website and add a new User Guide chapter #467.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds a substantial amount of user guide documentation by porting it from the main repository. The effort to consolidate and format this content is appreciated. However, the review has identified several issues that need addressing. There are critical errors in some YAML examples, such as typos in resource names, incorrect casing for kind, and the use of smart quotes, which will cause configurations to fail for users. Additionally, there are numerous formatting inconsistencies, including missing newlines at the end of files, improper use of HTML tags, and incorrect code block formatting. Several files also contain grammatical errors, typos, and misleading comments that reduce the clarity and professionalism of the documentation. Addressing these issues will significantly improve the quality and usability of the new user guide.

[Copilot]

Pull request overview

This PR synchronizes the Volcano User Guide documentation from the main repository to the website, adding comprehensive user documentation for version 1.11.0. The changes include new user guide pages, formatting improvements, image additions, and fixes for broken links.

Changes:

• Added 25+ user guide documents covering various Volcano features including vGPU, vNPU, plugins, scheduling, and performance tuning
• Fixed broken installation guide links in GPU virtualization documentation
• Added network topology images and created a new "User Guide" navigation chapter

Reviewed changes

Copilot reviewed 29 out of 43 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
config/_default/menus.toml	Adds "User Guide" menu entry to documentation navigation
content/en/docs/user_guide.md	Index page listing all user guide topics
content/en/docs/user_guide_*.md	25+ individual user guide documents for various Volcano features
content/en/docs/v1-11-0/gpu_virtualization.md	Fixed broken installation guide link
content/zh/docs/v1-11-0/gpu_virtualization.md	Fixed broken installation guide link (Chinese version)
static/img/network-topology/workload-deploy-example.png	Added network topology diagram image

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[JesseStutler]

Thanks! @aniketchawardol You did a great work, but you should sign off your commit to pass the DCO validation(use git commit -s), and fix gemini's review comments

[JesseStutler]

I prefer to place the user guide between the Key Features and Ecosystem sections (weight = 5), and adjust the weight of other sections accordingly.

[aniketchawardol]

coming soon!

[aniketchawardol]

Thanks! @aniketchawardol You did a great work, but you should sign off your commit to pass the DCO validation(use git commit -s), and fix gemini's review comments

Oh I think I forgot to do it on 2nd commit

[JesseStutler]

Thanks! @aniketchawardol You did a great work, but you should sign off your commit to pass the DCO validation(use git commit -s), and fix gemini's review comments

Oh I think I forgot to do it on 2nd commit

Yes you should squash your commits and force push again maybe, the 2nd commit didn't be signed off

[JesseStutler]

Wonderful! Thanks!
/approve
/lgtm

[volcano-sh-bot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: JesseStutler

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [JesseStutler]

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