Skip to content

translated refactored plugins to chinese this must be merged after #502#531

Open
hemantch01 wants to merge 7 commits into
volcano-sh:masterfrom
hemantch01:translate-zh-plugins
Open

translated refactored plugins to chinese this must be merged after #502#531
hemantch01 wants to merge 7 commits into
volcano-sh:masterfrom
hemantch01:translate-zh-plugins

Conversation

@hemantch01

Copy link
Copy Markdown
  • 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:
    Translates the Scheduler and Controller plugin documentation into Chinese using google translate api.

  • Which issue(s) this PR fixes:
    None

Signed-off-by: hemantch01 <hemantchaudhary905@gmail.com>

docs: reorganize plugin documentation into scheduler and controller

Signed-off-by: hemantch01 <hemantchaudhary905@gmail.com>

docs: add controller overview and update sidebar category positions

Signed-off-by: hemantch01 <hemantchaudhary905@gmail.com>
Signed-off-by: hemantch01 <hemantchaudhary905@gmail.com>
Signed-off-by: hemantch01 <hemantchaudhary905@gmail.com>

docs(i18n): add zh-Hans fallback content for Controller and new Scheduler plugins

Signed-off-by: hemantch01 <hemantchaudhary905@gmail.com>
…plugin restructure

- Update all /docs/UserGuide/user_guide_how_to_use_* links to new paths
- Update all /docs/Plugins/user_guide_how_to_use_* links to new paths
- Fix deviceshare.md relative links to UserGuide docs
- Scheduler plugins: capacity, cdp, nodegroup, resource_strategy_fit, task_topology
- Controller plugins: ray, pytorch, mpi, ssh, svc, env

Signed-off-by: hemantch01 <hemantchaudhary905@gmail.com>
@volcano-sh-bot volcano-sh-bot added the kind/documentation Categorizes issue or PR as related to documentation. label Jun 15, 2026
@volcano-sh-bot

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

@volcano-sh-bot volcano-sh-bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Jun 15, 2026

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

Copy link
Copy Markdown

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 restructures and expands the Volcano documentation, updating paths and adding several new plugin guides in both English and Chinese. The code review feedback is highly constructive and identifies critical issues to address: a nesting error in docusaurus.config.js that would break Docusaurus's broken markdown link handling, duplicated front matter in the Chinese drf.md file, multiple instances of untranslated English text and tables in the Chinese localization files, and the incorrect translation of 'Arguments' as '论点' instead of '参数' across several plugin documents.

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.

Comment thread docusaurus.config.js Outdated
Comment on lines +21 to +25
markdown: {
hooks: {
onBrokenMarkdownLinks: "throw",
},
},

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

high

In Docusaurus, onBrokenMarkdownLinks is a top-level configuration option and is not nested under markdown.hooks. Nesting it this way will cause Docusaurus to ignore the setting or throw a configuration validation error. Please keep it as a top-level option.

  onBrokenMarkdownLinks: "throw",

Comment on lines +124 to +125
## Note
* Please ensure `sshd` service is available in all containers.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

These lines are left untranslated in English. Since this is the Chinese translation file, they should be translated to Chinese.

Suggested change
## Note
* Please ensure `sshd` service is available in all containers.
## 注意
* 请确保所有容器中都可用 `sshd` 服务。

kubectl port-forward service/ray-cluster-job-head-svc 8265:8265 > /dev/null &
```

Now that the Dashboard port is accessible, submit jobs to the RayCluster:

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

This line is left untranslated in English. Since this is the Chinese translation file, it should be translated to Chinese.

Suggested change
Now that the Dashboard port is accessible, submit jobs to the RayCluster:
现在可以访问仪表板端口了,向 RayCluster 提交作业:

* 如果配置了“port”,则使“sshd”的端口值与参数值相同。
* 如果启用了“gang”插件,请确保“minAvailable”的值**等于**“worker 的副本”数量。

### 论点

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

In the context of command-line arguments or plugin parameters, 'Arguments' should be translated to '参数' (Parameters) rather than '论点'.

Suggested change
### 论点
### 参数


## Pytorch插件参数

### 论点

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

In the context of command-line arguments or plugin parameters, 'Arguments' should be translated to '参数' (Parameters) rather than '论点'.

Suggested change
### 论点
### 参数

Comment on lines +56 to +62
| Parameter | Description | Default |
|-----------|-------------|---------|
| `binpack.weight` | Overall weight of the Binpack plugin score | 1 |
| `binpack.cpu` | Weight for CPU resource in scoring | 1 |
| `binpack.memory` | Weight for Memory resource in scoring | 1 |
| `binpack.resources` | Additional resources to consider | - |
| `binpack.resources.<resource>` | Weight for specific resource type | 1 |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The table headers and descriptions are left untranslated in English. Since this is the Chinese translation file, they should be translated to Chinese.

Suggested change
| Parameter | Description | Default |
|-----------|-------------|---------|
| `binpack.weight` | Overall weight of the Binpack plugin score | 1 |
| `binpack.cpu` | Weight for CPU resource in scoring | 1 |
| `binpack.memory` | Weight for Memory resource in scoring | 1 |
| `binpack.resources` | Additional resources to consider | - |
| `binpack.resources.<resource>` | Weight for specific resource type | 1 |
| 参数 | 描述 | 默认值 |
|-----------|-------------|---------|
| `binpack.weight` | Binpack 插件评分的整体权重 | 1 |
| `binpack.cpu` | 评分中 CPU 资源的权重 | 1 |
| `binpack.memory` | 评分中内存资源的权重 | 1 |
| `binpack.resources` | 需要考虑的其他资源 | - |
| `binpack.resources.<resource>` | 特定资源类型的权重 | 1 |

Comment on lines +60 to +74
|-----------|-------------|---------|
| `nodeorder.weight` | Overall weight of the Nodeorder plugin | 1 |
| `nodeorder.leastrequested.enable` | Enable least requested resource scoring | true |
| `nodeorder.mostrequested.enable` | Enable most requested resource scoring | false |
| `nodeorder.nodeaffinity.enable` | Enable node affinity scoring | true |
| `nodeorder.podaffinity.enable` | Enable pod affinity scoring | true |
| `nodeorder.balancedresource.enable` | Enable balanced resource scoring | true |
| `nodeorder.imagelocality.enable` | Enable image locality scoring | true |
| `nodeorder.leastrequested.weight` | Weight for least requested scoring | 1 |
| `nodeorder.mostrequested.weight` | Weight for most requested scoring | 1 |
| `nodeorder.nodeaffinity.weight` | Weight for node affinity scoring | 1 |
| `nodeorder.podaffinity.weight` | Weight for pod affinity scoring | 1 |
| `nodeorder.balancedresource.weight` | Weight for balanced resource scoring | 1 |
| `nodeorder.imagelocality.weight` | Weight for image locality scoring | 1 |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The table headers and descriptions are left untranslated in English. Since this is the Chinese translation file, they should be translated to Chinese.

Suggested change
|-----------|-------------|---------|
| `nodeorder.weight` | Overall weight of the Nodeorder plugin | 1 |
| `nodeorder.leastrequested.enable` | Enable least requested resource scoring | true |
| `nodeorder.mostrequested.enable` | Enable most requested resource scoring | false |
| `nodeorder.nodeaffinity.enable` | Enable node affinity scoring | true |
| `nodeorder.podaffinity.enable` | Enable pod affinity scoring | true |
| `nodeorder.balancedresource.enable` | Enable balanced resource scoring | true |
| `nodeorder.imagelocality.enable` | Enable image locality scoring | true |
| `nodeorder.leastrequested.weight` | Weight for least requested scoring | 1 |
| `nodeorder.mostrequested.weight` | Weight for most requested scoring | 1 |
| `nodeorder.nodeaffinity.weight` | Weight for node affinity scoring | 1 |
| `nodeorder.podaffinity.weight` | Weight for pod affinity scoring | 1 |
| `nodeorder.balancedresource.weight` | Weight for balanced resource scoring | 1 |
| `nodeorder.imagelocality.weight` | Weight for image locality scoring | 1 |
| 参数 | 描述 | 默认值 |
|-----------|-------------|---------|
| `nodeorder.weight` | Nodeorder 插件的整体权重 | 1 |
| `nodeorder.leastrequested.enable` | 启用最少请求资源评分 | true |
| `nodeorder.mostrequested.enable` | 启用最多请求资源评分 | false |
| `nodeorder.nodeaffinity.enable` | 启用节点亲和性评分 | true |
| `nodeorder.podaffinity.enable` | 启用 Pod 亲和性评分 | true |
| `nodeorder.balancedresource.enable` | 启用均衡资源评分 | true |
| `nodeorder.imagelocality.enable` | 启用镜像本地性评分 | true |
| `nodeorder.leastrequested.weight` | 最少请求评分的权重 | 1 |
| `nodeorder.mostrequested.weight` | 最多请求评分的权重 | 1 |
| `nodeorder.nodeaffinity.weight` | 节点亲和性评分的权重 | 1 |
| `nodeorder.podaffinity.weight` | Pod 亲和性评分的权重 | 1 |
| `nodeorder.balancedresource.weight` | 均衡资源评分的权重 | 1 |
| `nodeorder.imagelocality.weight` | 镜像本地性评分的权重 | 1 |

Comment on lines +161 to +166
| Policy | Description |
|--------|-------------|
| `none` | NUMA 偏好 |
| `best-effort` | 尽量放置在最优 NUMA 节点,但不满足时不失败 |
| `restricted` | 仅放置在能满足 NUMA 要求的节点上 |
| `single-numa-node` | 所有资源必须来自单个 NUMA 节点 | No newline at end of file
| `none` | No NUMA preference |
| `best-effort` | Try to place on optimal NUMA node, but don't fail if not possible |
| `restricted` | Only place on nodes that can satisfy the NUMA requirement |
| `single-numa-node` | All resources must come from a single NUMA node | No newline at end of file

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The table headers and descriptions are left untranslated in English. Since this is the Chinese translation file, they should be translated to Chinese.

Suggested change
| Policy | Description |
|--------|-------------|
| `none` | 无 NUMA 偏好 |
| `best-effort` | 尽量放置在最优 NUMA 节点,但不满足时不失败 |
| `restricted` | 仅放置在能满足 NUMA 要求的节点上 |
| `single-numa-node` | 所有资源必须来自单个 NUMA 节点 |
\ No newline at end of file
| `none` | No NUMA preference |
| `best-effort` | Try to place on optimal NUMA node, but don't fail if not possible |
| `restricted` | Only place on nodes that can satisfy the NUMA requirement |
| `single-numa-node` | All resources must come from a single NUMA node |
| 策略 | 描述 |
|--------|-------------|
| `none` | 无 NUMA 偏好 |
| `best-effort` | 尽量放置在最优 NUMA 节点,但如果无法满足则不失败 |
| `restricted` | 仅放置在能满足 NUMA 要求的节点上 |
| `single-numa-node` | 所有资源必须来自单个 NUMA 节点 |

Comment on lines +51 to 53
|-----------|-------------|---------|
| `sla.JobWaitingTime` | Maximum waiting time for a job | - |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The table headers and descriptions are left untranslated in English. Since this is the Chinese translation file, they should be translated to Chinese.

Suggested change
|-----------|-------------|---------|
| `sla.JobWaitingTime` | Maximum waiting time for a job | - |
| 参数 | 描述 | 默认值 |
|-----------|-------------|---------|
| `sla.JobWaitingTime` | 作业的最长等待时间 | - |

Comment on lines +69 to +71
| Parameter | Description | Format |
|-----------|-------------|--------|
| `tdm.revocable-zone.<zone-name>` | 可撤销区域的时间窗口 | `<start-cron>:<end-cron>` |
| `tdm.revocable-zone.<zone-name>` | Time window for a revocable zone | `<start-cron>:<end-cron>` |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The table headers and descriptions are left untranslated in English. Since this is the Chinese translation file, they should be translated to Chinese.

Suggested change
| Parameter | Description | Format |
|-----------|-------------|--------|
| `tdm.revocable-zone.<zone-name>` | 可撤销区域的时间窗口 | `<start-cron>:<end-cron>` |
| `tdm.revocable-zone.<zone-name>` | Time window for a revocable zone | `<start-cron>:<end-cron>` |
| 参数 | 描述 | 格式 |
|-----------|-------------|--------|
| `tdm.revocable-zone.<zone-name>` | 可撤销区域的时间窗口 | `<start-cron>:<end-cron>` |

Signed-off-by: hemantch01 <hemantchaudhary905@gmail.com>
Signed-off-by: hemantch01 <hemantchaudhary905@gmail.com>
Signed-off-by: hemantch01 <hemantchaudhary905@gmail.com>
@hemantch01 hemantch01 force-pushed the translate-zh-plugins branch from 93b86ee to 77fa25f Compare June 15, 2026 06:44
@hemantch01

Copy link
Copy Markdown
Author

@JesseStutler

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.

2 participants