Skip to content

fix: correct technical errors in zh current docs#508

Open
mesutoezdil wants to merge 1 commit into
Project-HAMi:masterfrom
mesutoezdil:fix/zh-current-docs-technical-errors
Open

fix: correct technical errors in zh current docs#508
mesutoezdil wants to merge 1 commit into
Project-HAMi:masterfrom
mesutoezdil:fix/zh-current-docs-technical-errors

Conversation

@mesutoezdil

@mesutoezdil mesutoezdil commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Fix several technical errors in the Chinese (zh) current documentation:

  • installation/prerequisites.md: {nodeid} -> <node-name> in kubectl label command
  • get-started/deploy-with-helm.md: {节点ID} -> <node-name>, kubectl v1.16+ -> v1.23+, add missing -- in kubectl exec command
  • installation/online-installation.md: add helm repo update after helm repo add, remove deprecated --short flag from kubectl version, update example Kubernetes version from v1.16.8 to v1.29.0

These are the same categories of issues already fixed for the English docs in PRs #503 and #504.

Summary by CodeRabbit

  • Documentation
    • 更新中文安装与部署指南,补充更准确的命令示例和前置要求。
    • 调整节点打标签、检查资源与安装步骤的示例写法,便于按最新方式操作。
    • 升级 Helm 在线安装相关说明,新增仓库更新步骤,并同步示例 Kubernetes 版本。

Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
@hami-robot

hami-robot Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: mesutoezdil
Once this PR has been reviewed and has the lgtm label, please assign windsonsea 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

@hami-robot hami-robot Bot requested review from archlitchi and wawa0210 June 26, 2026 19:24
@netlify

netlify Bot commented Jun 26, 2026

Copy link
Copy Markdown

Deploy Preview for project-hami ready!

Name Link
🔨 Latest commit 110d1bb
🔍 Latest deploy log https://app.netlify.com/projects/project-hami/deploys/6a3ed1dcbafdbb0008a3953c
😎 Deploy Preview https://deploy-preview-508--project-hami.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 5b8545fe-2224-458e-bab7-2187257cef79

📥 Commits

Reviewing files that changed from the base of the PR and between a3e36d4 and 110d1bb.

📒 Files selected for processing (3)
  • i18n/zh/docusaurus-plugin-content-docs/current/get-started/deploy-with-helm.md
  • i18n/zh/docusaurus-plugin-content-docs/current/installation/online-installation.md
  • i18n/zh/docusaurus-plugin-content-docs/current/installation/prerequisites.md

📝 Walkthrough

Walkthrough

The Chinese Helm installation and deployment guides update command examples and version requirements. One install guide adds a repository update step and refreshed Kubernetes/version examples, while the deployment and prerequisites guides adjust kubectl minimum/version commands, node-label placeholders, and kubectl exec syntax.

Changes

Helm docs command updates

Layer / File(s) Summary
Online install steps
i18n/zh/docusaurus-plugin-content-docs/current/installation/online-installation.md
The online-installation guide adds helm repo update, changes the Kubernetes version command to kubectl version, and updates the scheduler image-tag example from v1.16.8 to v1.29.0.
Deployment commands
i18n/zh/docusaurus-plugin-content-docs/current/get-started/deploy-with-helm.md, i18n/zh/docusaurus-plugin-content-docs/current/installation/prerequisites.md
The deployment and prerequisites guides raise the documented kubectl minimum to v1.23+, change node-label placeholders to <node-name>, and update the kubectl exec example to kubectl exec -it gpu-pod -- nvidia-smi.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 I hopped through the docs at dawn,
With Helm crumbs neatly swept along.
kubectl got a newer tune,
And -- joined the exec moon.
Fluffy ears say: “Hop, docs, hop on!”

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the PR’s main change: fixing technical errors in the Chinese current docs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@hami-robot hami-robot Bot added the size/S label Jun 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant