Skip to content

fix: replace curly-brace IP and node placeholders in monitoring and volcano-vgpu docs#506

Open
mesutoezdil wants to merge 1 commit into
Project-HAMi:masterfrom
mesutoezdil:fix/ip-placeholders-monitoring-volcano
Open

fix: replace curly-brace IP and node placeholders in monitoring and volcano-vgpu docs#506
mesutoezdil wants to merge 1 commit into
Project-HAMi:masterfrom
mesutoezdil:fix/ip-placeholders-monitoring-volcano

Conversation

@mesutoezdil

@mesutoezdil mesutoezdil commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Replace curly-brace placeholders with angle-bracket form to match the convention used elsewhere:

  • {GPU node ip} -> <GPU-node-ip> in real-time-device-usage.md
  • {scheduler node ip} -> <scheduler-ip> in device-allocation.md
  • {volcano scheduler cluster ip} -> <scheduler-ip> in monitor.md and both how-to-use-volcano-vgpu.md files
  • {node name} -> <node-name> in both how-to-use-volcano-vgpu.md files

Files changed:

  • docs/userguide/monitoring/real-time-device-usage.md
  • docs/userguide/monitoring/device-allocation.md
  • docs/userguide/volcano-vgpu/nvidia-gpu/monitor.md
  • docs/userguide/volcano-vgpu/nvidia-gpu/how-to-use-volcano-vgpu.md
  • docs/installation/how-to-use-volcano-vgpu.md

Summary by CodeRabbit

  • Documentation
    • Improved several user guide and installation examples with clearer placeholder text for cluster node names and IP addresses.
    • Standardized metrics endpoint examples across vGPU and monitoring docs for easier copy-and-paste use.
    • Updated command snippets to use consistent angle-bracket placeholders, making setup and verification steps easier to follow.

…olcano-vgpu docs

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 wawa0210 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 rootsongjc and windsonsea June 26, 2026 19:19
@netlify

netlify Bot commented Jun 26, 2026

Copy link
Copy Markdown

Deploy Preview for project-hami ready!

Name Link
🔨 Latest commit d5c1b1e
🔍 Latest deploy log https://app.netlify.com/projects/project-hami/deploys/6a3ed0c34d4567000820be06
😎 Deploy Preview https://deploy-preview-506--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 added the size/S label Jun 26, 2026
@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: d35a677d-455c-4fd5-9cbd-55f71bf8549e

📥 Commits

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

📒 Files selected for processing (5)
  • docs/installation/how-to-use-volcano-vgpu.md
  • docs/userguide/monitoring/device-allocation.md
  • docs/userguide/monitoring/real-time-device-usage.md
  • docs/userguide/volcano-vgpu/nvidia-gpu/how-to-use-volcano-vgpu.md
  • docs/userguide/volcano-vgpu/nvidia-gpu/monitor.md

📝 Walkthrough

Walkthrough

Updated Volcano vGPU and monitoring documentation examples to use angle-bracket placeholders for node names, scheduler IPs, and GPU node IPs in CLI snippets and endpoint text.

Changes

Volcano vGPU and monitoring placeholder updates

Layer / File(s) Summary
Placeholder text updates
docs/installation/how-to-use-volcano-vgpu.md, docs/userguide/volcano-vgpu/nvidia-gpu/how-to-use-volcano-vgpu.md, docs/userguide/volcano-vgpu/nvidia-gpu/monitor.md, docs/userguide/monitoring/device-allocation.md, docs/userguide/monitoring/real-time-device-usage.md
Documentation examples and endpoint references replace brace-style placeholders with angle-bracket placeholders for node names, scheduler IPs, and GPU node IPs.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 I hopped through docs with a tidy grin,
<node-name> and <scheduler-ip> now fit right in.
The metrics paths still glow so bright,
With placeholders neat and syntax light.
Thump thump—my whiskers say, “all looks right!”

🚥 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 main change: replacing curly-brace placeholders in the monitoring and Volcano vGPU 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.

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