docs(userguide): add component support tags to feature pages - #713
Open
singhsrijan46 wants to merge 2 commits into
Open
docs(userguide): add component support tags to feature pages#713singhsrijan46 wants to merge 2 commits into
singhsrijan46 wants to merge 2 commits into
Conversation
Signed-off-by: Srijan <singhsrijangkp@gmail.com>
hami-robot
Bot
added
kind/documentation
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: singhsrijan46 The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
✅ Deploy Preview for project-hami ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe NVIDIA device documentation now includes supported-component banners for dynamic MIG and dynamic resource allocation. The versioned dynamic MIG documentation also removes a duplicate A100-SXM4-40GB entry. ChangesNVIDIA device documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
4 tasks
Signed-off-by: Srijan <singhsrijangkp@gmail.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/userguide/nvidia-device/dynamic-mig-support.md`:
- Around line 5-10: Update every supported-component banner to meet the 4.5:1
WCAG AA contrast target by replacing the current saturated backgrounds or
switching to suitably dark text. Apply the accessible HAMi, Volcano, and
HAMi-DRA colors in docs/userguide/nvidia-device/dynamic-mig-support.md:5-10;
HAMi-DRA, HAMi, and CDI Support colors in
docs/userguide/nvidia-device/dynamic-resource-allocation.md:6-10; translated
banners in
i18n/zh/docusaurus-plugin-content-docs/current/userguide/nvidia-device/dynamic-mig-support.md:6-10
and
i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/userguide/nvidia-device/dynamic-mig-support.md:6-10;
and versioned English banners in
versioned_docs/version-v2.9.0/userguide/nvidia-device/dynamic-mig-support.md:5-10
and
versioned_docs/version-v2.9.0/userguide/nvidia-device/dynamic-resource-allocation.md:6-10.
In `@docs/userguide/nvidia-device/dynamic-resource-allocation.md`:
- Around line 6-12: Mirror the supported-components banner in both the current
Chinese page and the v2.9.0 Chinese page, using equivalent styling and
`/zh/docs/...` URLs for HAMi-DRA, HAMi, and CDI Support; do not modify the
v2.8.0 Chinese page.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 11d8bc5f-831e-42a9-b84d-74fb627efa63
📒 Files selected for processing (6)
docs/userguide/nvidia-device/dynamic-mig-support.mddocs/userguide/nvidia-device/dynamic-resource-allocation.mdi18n/zh/docusaurus-plugin-content-docs/current/userguide/nvidia-device/dynamic-mig-support.mdi18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/userguide/nvidia-device/dynamic-mig-support.mdversioned_docs/version-v2.9.0/userguide/nvidia-device/dynamic-mig-support.mdversioned_docs/version-v2.9.0/userguide/nvidia-device/dynamic-resource-allocation.md
Comment on lines
+5
to
+10
| <div style={{ display: 'flex', alignItems: 'center', gap: '8px', marginBottom: '20px', flexWrap: 'wrap' }}> | ||
| <strong style={{ fontSize: '0.9rem' }}>Supported Components:</strong> | ||
| <a href="/docs/get-started/deploy-with-helm" style={{ display: 'inline-block', padding: '3px 12px', borderRadius: '12px', background: '#10b981', color: '#fff', fontWeight: 600, fontSize: '0.82rem', textDecoration: 'none' }}>HAMi</a> | ||
| <a href="/docs/userguide/volcano-vgpu/nvidia-gpu/how-to-use-volcano-vgpu" style={{ display: 'inline-block', padding: '3px 12px', borderRadius: '12px', background: '#3b82f6', color: '#fff', fontWeight: 600, fontSize: '0.82rem', textDecoration: 'none' }}>Volcano</a> | ||
| <a href="/docs/userguide/nvidia-device/dynamic-resource-allocation" style={{ display: 'inline-block', padding: '3px 12px', borderRadius: '12px', background: '#8b5cf6', color: '#fff', fontWeight: 600, fontSize: '0.82rem', textDecoration: 'none' }}>HAMi-DRA</a> | ||
| </div> |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Use an accessible color palette for all supported-component banners. The repeated white-on-saturated palette fails the 4.5:1 WCAG AA target for normal text. Use darker background colors or dark text at every site. (w3.org)
docs/userguide/nvidia-device/dynamic-mig-support.md#L5-L10: update the HAMi, Volcano, and HAMi-DRA colors.docs/userguide/nvidia-device/dynamic-resource-allocation.md#L6-L10: update the HAMi-DRA, HAMi, and CDI Support colors.i18n/zh/docusaurus-plugin-content-docs/current/userguide/nvidia-device/dynamic-mig-support.md#L6-L10: update the translated banner colors.i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/userguide/nvidia-device/dynamic-mig-support.md#L6-L10: update the versioned Chinese banner colors.versioned_docs/version-v2.9.0/userguide/nvidia-device/dynamic-mig-support.md#L5-L10: update the versioned English banner colors.versioned_docs/version-v2.9.0/userguide/nvidia-device/dynamic-resource-allocation.md#L6-L10: update the versioned English banner colors.
📍 Affects 6 files
docs/userguide/nvidia-device/dynamic-mig-support.md#L5-L10(this comment)docs/userguide/nvidia-device/dynamic-resource-allocation.md#L6-L10i18n/zh/docusaurus-plugin-content-docs/current/userguide/nvidia-device/dynamic-mig-support.md#L6-L10i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/userguide/nvidia-device/dynamic-mig-support.md#L6-L10versioned_docs/version-v2.9.0/userguide/nvidia-device/dynamic-mig-support.md#L5-L10versioned_docs/version-v2.9.0/userguide/nvidia-device/dynamic-resource-allocation.md#L6-L10
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/userguide/nvidia-device/dynamic-mig-support.md` around lines 5 - 10,
Update every supported-component banner to meet the 4.5:1 WCAG AA contrast
target by replacing the current saturated backgrounds or switching to suitably
dark text. Apply the accessible HAMi, Volcano, and HAMi-DRA colors in
docs/userguide/nvidia-device/dynamic-mig-support.md:5-10; HAMi-DRA, HAMi, and
CDI Support colors in
docs/userguide/nvidia-device/dynamic-resource-allocation.md:6-10; translated
banners in
i18n/zh/docusaurus-plugin-content-docs/current/userguide/nvidia-device/dynamic-mig-support.md:6-10
and
i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/userguide/nvidia-device/dynamic-mig-support.md:6-10;
and versioned English banners in
versioned_docs/version-v2.9.0/userguide/nvidia-device/dynamic-mig-support.md:5-10
and
versioned_docs/version-v2.9.0/userguide/nvidia-device/dynamic-resource-allocation.md:6-10.
Source: MCP tools
Comment on lines
+6
to
+12
| <div style={{ display: 'flex', alignItems: 'center', gap: '8px', marginBottom: '20px', flexWrap: 'wrap' }}> | ||
| <strong style={{ fontSize: '0.9rem' }}>Supported Components:</strong> | ||
| <a href="/docs/installation/how-to-use-hami-dra" style={{ display: 'inline-block', padding: '3px 12px', borderRadius: '12px', background: '#8b5cf6', color: '#fff', fontWeight: 600, fontSize: '0.82rem', textDecoration: 'none' }}>HAMi-DRA</a> | ||
| <a href="/docs/get-started/deploy-with-helm" style={{ display: 'inline-block', padding: '3px 12px', borderRadius: '12px', background: '#10b981', color: '#fff', fontWeight: 600, fontSize: '0.82rem', textDecoration: 'none' }}>HAMi</a> | ||
| <a href="/docs/installation/configure-cdi" style={{ display: 'inline-block', padding: '3px 12px', borderRadius: '12px', background: '#0ea5e9', color: '#fff', fontWeight: 600, fontSize: '0.82rem', textDecoration: 'none' }}>CDI Support</a> | ||
| </div> | ||
|
|
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -eu
printf '%s\n' '--- candidate documentation files ---'
fd -i 'dynamic-resource-allocation\.md$' . | sort
printf '%s\n' '--- English current page ---'
eng="$(fd -i 'dynamic-resource-allocation\.md$' docs | head -n 1)"
if [ -n "${eng:-}" ]; then
cat -n "$eng" | sed -n '1,35p'
fi
printf '%s\n' '--- Chinese counterparts and banner text ---'
for f in $(fd -i 'dynamic-resource-allocation\.md$' i18n 2>/dev/null | sort); do
echo "FILE: $f"
rg -n -C 3 'Supported Components|HAMi-DRA|CDI Support|支持组件|动态资源' "$f" || true
doneRepository: Project-HAMi/website
Length of output: 5116
🏁 Script executed:
#!/bin/bash
set -eu
printf '%s\n' '--- all current documentation copies ---'
fd -i 'dynamic-resource-allocation\.md$' docs i18n 2>/dev/null | sort
printf '%s\n' '--- exact banner/link occurrences ---'
rg -n -C 2 -S 'how-to-use-hami-dra|deploy-with-helm|configure-cdi|Supported Components|支持组件' docs i18n 2>/dev/null || true
printf '%s\n' '--- documentation navigation configuration ---'
fd -i 'sidebars\.js$' . -x sh -c 'echo "FILE: $1"; rg -n -C 2 "dynamic-resource-allocation|nvidia-device" "$1" || true' sh {} \;Repository: Project-HAMi/website
Length of output: 29456
🏁 Script executed:
#!/bin/bash
set -eu
printf '%s\n' '--- page paths and language/version structure ---'
fd -t f -i 'dynamic-resource-allocation\.md$' . | sort
printf '%s\n' '--- English and Chinese page headers ---'
for f in $(fd -t f -i 'dynamic-resource-allocation\.md$' . | sort); do
echo "FILE: $f"
sed -n '1,30p' "$f"
doneRepository: Project-HAMi/website
Length of output: 8799
🏁 Script executed:
#!/bin/bash
set -eu
printf '%s\n' '--- documentation files ---'
fd -t f -i 'dynamic-resource-allocation\.md$' . | sort
printf '%s\n' '--- relevant links and banner text ---'
rg -n -C 3 -S 'how-to-use-hami-dra|deploy-with-helm|configure-cdi|Supported Components|支持组件' docs i18n 2>/dev/null || trueRepository: Project-HAMi/website
Length of output: 35255
Mirror the banner in the Chinese documentation.
The current Chinese page and the v2.9.0 Chinese page lack the banner. Add the equivalent banner to both pages and use /zh/docs/... links. Leave v2.8.0 unchanged because its English page lacks this banner.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/userguide/nvidia-device/dynamic-resource-allocation.md` around lines 6 -
12, Mirror the supported-components banner in both the current Chinese page and
the v2.9.0 Chinese page, using equivalent styling and `/zh/docs/...` URLs for
HAMi-DRA, HAMi, and CDI Support; do not modify the v2.8.0 Chinese page.
Source: Coding guidelines
Contributor
Author
|
I have updated the PR and pushed the new changes: Everything builds cleanly and passes all linting tests with DCO sign-off. Let me know if any further changes are needed. Thanks. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
/kind documentation
What this PR does / why we need it:
Added component tags on feature pages so users can quickly see which scheduler modes are supported.
Changes made:
Added clickable tags (HAMi, Volcano, HAMi-DRA) at the top of
dynamic-mig-support.mdanddynamic-resource-allocation.md.Updated Chinese translation files in
i18n/zh/.Which issue(s) this PR fixes:
Part of #689
Checklist:
npm run lintandnpm run format:checkpassnpm run buildsucceeds for bothenandzhgit commit -s)Summary by CodeRabbit