Skip to content

docs(userguide): add component support tags to feature pages #713

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
singhsrijan46 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs(userguide): add component support tags to feature pages #713

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5accb00
docs(userguide): add component support tags to feature pages
singhsrijan46 Aug 3, 2026
3433edc
fix(versions): sync component tags to v2.9.0 stable release
singhsrijan46 Aug 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/userguide/nvidia-device/dynamic-mig-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
title: Enable dynamic MIG feature
---

<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>
Comment on lines +5 to +10

@coderabbitai coderabbitai Bot Aug 10, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 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-L10
  • i18n/zh/docusaurus-plugin-content-docs/current/userguide/nvidia-device/dynamic-mig-support.md#L6-L10
  • i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/userguide/nvidia-device/dynamic-mig-support.md#L6-L10
  • versioned_docs/version-v2.9.0/userguide/nvidia-device/dynamic-mig-support.md#L5-L10
  • versioned_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


HAMi now supports dynamic MIG using mig-parted to adjust MIG devices dynamically, including:

- **Dynamic MIG Instance Management**: Users no longer need to operate directly on GPU nodes or use commands like `nvidia-smi -i 0 -mig 1` to manage MIG instances. HAMi-device-plugin will handle this automatically.
Expand Down
7 changes: 7 additions & 0 deletions docs/userguide/nvidia-device/dynamic-resource-allocation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@ title: Dynamic Resource Allocation
translated: true
---

<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>

Comment on lines +6 to +12

@coderabbitai coderabbitai Bot Aug 10, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 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
done

Repository: 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"
done

Repository: 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 || true

Repository: 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

## Introduction

HAMi has supported K8s [DRA](https://kubernetes.io/docs/concepts/scheduling-eviction/dynamic-resource-allocation/) (Dynamic Resource Allocation) on NVIDIA devices. By installing hami-k8s-dra-driver, your cluster scheduler can discover NVIDIA GPU devices on nodes.
Expand Down
7 changes: 7 additions & 0 deletions ...urus-plugin-content-docs/current/userguide/nvidia-device/dynamic-mig-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@ title: 启用动态 MIG 功能
translated: true
---

<div style={{ display: 'flex', alignItems: 'center', gap: '8px', marginBottom: '20px', flexWrap: 'wrap' }}>
<strong style={{ fontSize: '0.9rem' }}>支持组件/模式：</strong>
<a href="/zh/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="/zh/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="/zh/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>

## 介绍

**我们现在支持通过使用 mig-parted 动态调整 mig-devices 来支持 dynamic-mig**，包括：
Expand Down
9 changes: 8 additions & 1 deletion ...ugin-content-docs/version-v2.9.0/userguide/nvidia-device/dynamic-mig-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@ title: 启用动态 MIG 功能
translated: true
---

<div style={{ display: 'flex', alignItems: 'center', gap: '8px', marginBottom: '20px', flexWrap: 'wrap' }}>
<strong style={{ fontSize: '0.9rem' }}>支持组件/模式：</strong>
<a href="/zh/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="/zh/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="/zh/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>

## 介绍

**我们现在支持通过使用 mig-parted 动态调整 mig-devices 来支持 dynamic-mig**，包括：
Expand Down Expand Up @@ -89,7 +96,7 @@ nvidia:
memory: 24576
count: 1

- models: ["A100-SXM4-40GB", "A100-40GB-PCIe", "A100-PCIE-40GB", "A100-SXM4-40GB"]
- models: ["A100-SXM4-40GB", "A100-40GB-PCIe", "A100-PCIE-40GB"]
allowedGeometries:
- name: 1g.5gb
memory: 5120
Expand Down
9 changes: 8 additions & 1 deletion versioned_docs/version-v2.9.0/userguide/nvidia-device/dynamic-mig-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
title: Enable dynamic MIG feature
---

<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>

HAMi now supports dynamic MIG using mig-parted to adjust MIG devices dynamically, including:

- **Dynamic MIG Instance Management**: Users no longer need to operate directly on GPU nodes or use commands like `nvidia-smi -i 0 -mig 1` to manage MIG instances. HAMi-device-plugin will handle this automatically.
Expand Down Expand Up @@ -86,7 +93,7 @@ nvidia:
memory: 24576
count: 1

- models: ["A100-SXM4-40GB", "A100-40GB-PCIe", "A100-PCIE-40GB", "A100-SXM4-40GB"]
- models: ["A100-SXM4-40GB", "A100-40GB-PCIe", "A100-PCIE-40GB"]
allowedGeometries:
- name: 1g.5gb
memory: 5120
Expand Down
7 changes: 7 additions & 0 deletions ...oned_docs/version-v2.9.0/userguide/nvidia-device/dynamic-resource-allocation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@ title: Dynamic Resource Allocation
translated: true
---

<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>

## Introduction

HAMi has supported K8s [DRA](https://kubernetes.io/docs/concepts/scheduling-eviction/dynamic-resource-allocation/) (Dynamic Resource Allocation) on NVIDIA devices. By installing hami-k8s-dra-driver, your cluster scheduler can discover NVIDIA GPU devices on nodes.
Expand Down