Skip to content

Docs: Add user guide and user_guide_how_to_configure_priorityclass_for_job#478

Open
codeEvolveZenith345 wants to merge 6 commits intovolcano-sh:masterfrom
codeEvolveZenith345:feat/add-chinese-user-guide
Open

Docs: Add user guide and user_guide_how_to_configure_priorityclass_for_job#478
codeEvolveZenith345 wants to merge 6 commits intovolcano-sh:masterfrom
codeEvolveZenith345:feat/add-chinese-user-guide

Conversation

@codeEvolveZenith345
Copy link
Contributor

@codeEvolveZenith345 codeEvolveZenith345 commented Feb 5, 2026

  • Please check if the PR fulfills these requirements
  • The commit message follows our guidelines
  • 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 Chinese translation for the User Guide section to mirror the English documentation structure added in PR #472.

Changes include:

  • Created new "用户指南" (User Guide) section in Chinese documentation (content/zh/docs/user_guide.md)
  • Translated the "How to Configure PriorityClass for Job" guide from English to Chinese (content/zh/docs/user_guide_how_to_configure_priorityclass_for_job.md)
  • Maintained consistent navigation structure between English and Chinese documentation
  • Included all 26 user guide topics in the Chinese index with proper links

This ensures Chinese-speaking users have access to comprehensive user guides in their native language, improving accessibility and usability of the Volcano documentation.

  • Which issue(s) this PR fixes:

Fixes #476

…r_job

Signed-off-by: Lakshya Saxena <suntiwari3495@gmail.com>
Signed-off-by: Lakshya Saxena <suntiwari3495@gmail.com>
@volcano-sh-bot volcano-sh-bot added the kind/documentation Categorizes issue or PR as related to documentation. label Feb 5, 2026
@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 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:

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
Copy link

Summary of Changes

Hello @codeEvolveZenith345, I'm Gemini Code Assist1! 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!

此拉取请求旨在通过引入全面的中文用户指南,显著提升 Volcano 文档对中文用户的可访问性和可用性。它通过镜像现有英文文档的结构,确保中文用户能够以其母语获取一致且详细的操作指导。

Highlights

  • 新增中文用户指南主页: 创建了 content/zh/docs/user_guide.md 文件,作为中文用户指南的入口,其中包含了25个用户指南主题的链接。
  • 翻译 PriorityClass 配置指南: 将“如何为作业配置 PriorityClass”指南从英文翻译成中文,并新增至 content/zh/docs/user_guide_how_to_configure_priorityclass_for_job.md 文件。
  • 保持文档结构一致性: 确保中文文档的用户指南部分与英文文档保持一致的导航结构。
  • 完善中文用户指南索引: 在中文用户指南主页中包含了所有25个用户指南主题,并提供了正确的链接。

🧠 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
  • content/zh/docs/user_guide.md
    • 新增文件,作为中文用户指南的索引页。
    • 定义了文档的元数据,如标题、权重和URL。
    • 列出了25个不同的用户指南主题,并提供了相应的中文链接。
  • content/zh/docs/user_guide_how_to_configure_priorityclass_for_job.md
    • 新增文件,提供了“如何为作业配置 PriorityClass”的中文翻译指南。
    • 详细解释了在 Volcano Job 中配置 PriorityClass 的背景、关键点和示例 YAML 配置。
    • 阐明了任务如何继承或覆盖 Job 级别的 PriorityClass 配置。
Activity
  • 由于未提供具体的评论、审查或进展信息,此拉取请求的活动仅限于其创建和提交。
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.

@volcano-sh-bot volcano-sh-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 5, 2026
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces Chinese translations for the user guide, adding an index page and a guide on configuring PriorityClass for jobs. The new documentation mirrors the English structure and the translation is accurate and clear. I have one minor suggestion to improve the clarity of a comment in an example. Overall, this is a valuable contribution to improving the accessibility of the documentation.

@codeEvolveZenith345
Copy link
Contributor Author

Work in progress, some commits to be pushed!

@codeEvolveZenith345 codeEvolveZenith345 marked this pull request as draft February 5, 2026 10:09
@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 5, 2026
…uide_how_to_use_capacity_plugin.md

Signed-off-by: Lakshya Saxena <suntiwari3495@gmail.com>
… user_guide_how_to_use_extender user_guide_how_to_use_job_policy

Signed-off-by: Lakshya Saxena <suntiwari3495@gmail.com>
@volcano-sh-bot volcano-sh-bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 5, 2026
Signed-off-by: Lakshya Saxena <suntiwari3495@gmail.com>
@codeEvolveZenith345 codeEvolveZenith345 marked this pull request as ready for review February 5, 2026 15:33
@volcano-sh-bot volcano-sh-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 5, 2026
Signed-off-by: Lakshya Saxena <suntiwari3495@gmail.com>
@codeEvolveZenith345
Copy link
Contributor Author

/cc @JesseStutler

Ready for review! I have reviewed the implementation once, Please review it!

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

Labels

kind/documentation Categorizes issue or PR as related to documentation. 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.

[Docs] Add Chinese '用户指南' section and translate user guide to Chinese

2 participants