Skip to content

docs: fix scheduler policy flag, schedulerName case, and stale link - #604

Merged
hami-robot[bot] merged 1 commit into
Project-HAMi:masterfrom
Wangmin362:pr-c-scheduling
Jul 13, 2026
Merged

hami-robot[bot] merged 1 commit into
Project-HAMi:masterfrom
Wangmin362:pr-c-scheduling

Conversation

@Wangmin362

@Wangmin362 Wangmin362 commented Jul 13, 2026 •

Copy link
Copy Markdown
Member

What this PR does / why we need it

Three small correctness fixes in scheduler/concept docs:

  • schedulerName casing (core-concepts/architecture.md) — the MutatingWebhook sets schedulerName to hami-scheduler (lowercase), not HAMi-scheduler. This value is case-sensitive; the same file's own section anchor is {#hami-scheduler} and the chart's scheduler.schedulerName is hami-scheduler.
  • Scheduler policy flag (developers/gpu-topology-scheduling.md) — the topology policy is set via the --gpu-scheduler-policy flag (leading --), defined in Project-HAMi/HAMi cmd/scheduler/main.go (rootCmd.Flags().StringVar(&device.GPUSchedulerPolicy, "gpu-scheduler-policy", ...)). The doc dropped the --.
  • Stale link (concept.md) — the volcano-vgpu-device-plugin link pointed at github.com/volcano-sh/devices; it should point to github.com/Project-HAMi/volcano-vgpu-device-plugin, which is what the other docs on this site already link to.

Both the docs/ version and the i18n/zh mirror are updated.

Verification

  • npm run check:all (markdownlint + prettier + build + linkinator) passes locally.
  • Values checked against the HAMi chart and cmd/scheduler flag definitions.

AI assistance

Drafted with AI assistance (Claude Code) and reviewed and verified by me, including the source cross-checks above.

Summary by CodeRabbit

  • Documentation
    • Corrected scheduler naming in architecture documentation.
    • Fixed the GPU topology scheduling command example to use the proper CLI flag format.
    • Updated the referenced device plugin link to point to the repository homepage.
    • Applied corresponding corrections to the Chinese documentation.

- schedulerName value is 'hami-scheduler' (lowercase, case-sensitive)
- the scheduler policy is set via the --gpu-scheduler-policy flag (needs --)
- point the volcano-vgpu-device-plugin link to the Project-HAMi repo

Signed-off-by: wangmin <wangmin@riseunion.io>
@netlify

netlify Bot commented Jul 13, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for project-hami ready!

Name Link
🔨 Latest commit e8f8b7a
🔍 Latest deploy log https://app.netlify.com/projects/project-hami/deploys/6a5457d35bd16800081519c1
😎 Deploy Preview https://deploy-preview-604--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.

@hami-robot
hami-robot Bot requested review from rootsongjc and windsonsea July 13, 2026 03:13
@hami-robot hami-robot Bot added the size/S label Jul 13, 2026
@coderabbitai

coderabbitai Bot commented Jul 13, 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: 5cf749e9-5f75-48b8-9c0b-a7aa2c32b7c5

📥 Commits

Reviewing files that changed from the base of the PR and between 0bdbbc8 and e8f8b7a.

📒 Files selected for processing (5)
  • concept.md
  • docs/core-concepts/architecture.md
  • docs/developers/gpu-topology-scheduling.md
  • i18n/zh/docusaurus-plugin-content-docs/current/core-concepts/architecture.md
  • i18n/zh/docusaurus-plugin-content-docs/current/developers/gpu-topology-scheduling.md

📝 Walkthrough

Walkthrough

Documentation is updated to correct the hami-scheduler name, add the missing CLI flag prefix, and point the volcano-vgpu-device-plugin link to the repository root in English and Chinese content.

Changes

Documentation Corrections

Layer / File(s) Summary
Scheduler name documentation
docs/core-concepts/architecture.md, i18n/zh/.../core-concepts/architecture.md
The documented Pod schedulerName changes from HAMi-scheduler to hami-scheduler.
Scheduler CLI examples
docs/developers/gpu-topology-scheduling.md, i18n/zh/.../developers/gpu-topology-scheduling.md
The topology-aware scheduler command uses --gpu-scheduler-policy=topology-aware.
Repository hyperlink
concept.md
The volcano-vgpu-device-plugin link no longer includes the /devices suffix.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested labels: lgtm, approved

Suggested reviewers: archlitchi, wawa0210

Poem

A rabbit hops through docs so bright,
Fixing scheduler names just right.
Flags gain dashes, links take flight,
English and Chinese shine in light.
Thump-thump—review done tonight!

🚥 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 three documentation fixes in the pull request.
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

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@hami-robot

hami-robot Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

Approval requirements bypassed by manually added approval.

This pull-request has been approved by: Wangmin362

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:

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

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