Skip to content

Synchronize User Guide from volcano/docs to website with navigation#468

Closed
Copilot wants to merge 2 commits intomasterfrom
copilot/synchronize-user-guide-content
Closed

Synchronize User Guide from volcano/docs to website with navigation#468
Copilot wants to merge 2 commits intomasterfrom
copilot/synchronize-user-guide-content

Conversation

Copy link
Contributor

Copilot AI commented Feb 3, 2026

Adds 25 User Guide documents from volcano-sh/volcano/docs/user-guide to the website documentation.

Changes

  • Content: Copied 25 markdown guides covering scheduler configuration, GPU management (sharing/vGPU/number), plugins (MPI/PyTorch/Ray/SSH/SVC/Env/CDP), NUMA, DRA, network topology, performance tuning, and job policies
  • Structure: Created /content/en/docs/user-guide/ with index page and Hugo frontmatter for all guides using [menu.user-guide] to satisfy theme requirements
  • Navigation: Added "User Guide" section to docs menu in menus.toml and languages.toml (EN: "User Guide", ZH: "用户指南") for all versions (latest, v1.7.0-v1.12.0), positioned between Ecosystem and Scheduler sections
  • Theme compatibility: Configured submenu structure with proper URL references (/en/docs/user-guide/) to work with Academic theme's directory-based menu detection

Site builds successfully with 294 total pages. User Guide accessible at /en/docs/user-guide/ with sidebar navigation across all 25 guides.

Original prompt

This section details on the original issue you should resolve

<issue_title>Synchronize Volcano User Guide from docs to website and add a new User Guide chapter</issue_title>
<issue_description>The Volcano main repository contains a detailed User Guide under docs/user-guide.

We should synchronize the content of the User Guide from volcano-sh/volcano (https://github.com/volcano-sh/volcano/tree/main/docs/user-guide) to the volcano-sh/website project( and we can add a sync workflow to update the user guide also into website docs, but we can do that in the future). The website should add a new chapter dedicated to the User Guide.

Acceptance Criteria:

  • All sections of the User Guide from volcano-sh/volcano are copied and integrated into volcano-sh/website.
  • A new "User Guide" chapter is created in the website navigation/menu.
  • Content is presented clearly and formatted appropriately for web consumption.

References:

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@volcano-sh-bot volcano-sh-bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 3, 2026
@volcano-sh-bot volcano-sh-bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Feb 3, 2026
…itory

Co-authored-by: JesseStutler <38534065+JesseStutler@users.noreply.github.com>
@volcano-sh-bot
Copy link
Collaborator

[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 ask for approval from jessestutler. 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:

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

@volcano-sh-bot volcano-sh-bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 3, 2026
Copilot AI changed the title [WIP] Synchronize Volcano User Guide to website and add new chapter Synchronize User Guide from volcano/docs to website with navigation Feb 3, 2026
Copilot AI requested a review from JesseStutler February 3, 2026 13:04
@JesseStutler
Copy link
Member

I think #472 is better, close

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Synchronize Volcano User Guide from docs to website and add a new User Guide chapter

3 participants