Skip to content

docs: add 5-minute quick start path (#412)#425

Open
mesutoezdil wants to merge 2 commits into
Project-HAMi:masterfrom
mesutoezdil:docs/quickstart-412
Open

docs: add 5-minute quick start path (#412)#425
mesutoezdil wants to merge 2 commits into
Project-HAMi:masterfrom
mesutoezdil:docs/quickstart-412

Conversation

@mesutoezdil
Copy link
Copy Markdown
Contributor

@mesutoezdil mesutoezdil commented May 29, 2026

  • Adds docs/get-started/quick-path.md: a minimal install-and-verify path targeting users with a running Kubernetes cluster and pre-configured GPU nodes
  • Places it first in the get-started sidebar so first-time users reach the fastest path before the full deployment guide
  • Build passes for both en and zh locales

Scope

The quickstart covers exactly what the issue asks for:

  • Prerequisites: 4 bullet points, all hard requirements only (K8s v1.18+, NVIDIA driver v440+, nvidia-container-toolkit as default runtime, Helm v3+)
  • Install path: helm repo add + helm install (two commands)
  • Node labeling: one kubectl label command
  • Verification: kubectl get pods -n kube-system | grep hami
  • GPU sharing example: one pod requesting 1 vGPU and 4096 MiB memory cap
  • Expected output: nvidia-smi showing 4096MiB Total Memory, confirming isolation
  • Next steps: links to full installation guide, validate page, configure page, and device sharing concept

What is not included

  • Runtime configuration (covered in Prerequisites - linked with a note)
  • Offline install, multi-node setup, non-NVIDIA devices - all linked to the installation section
  • Chinese translation - not required for initial PR per issue scope

Closes #412.

Creates docs/get-started/quick-path.md with a minimal install-and-verify
flow: prerequisites check, two Helm commands, node labeling, one GPU
sharing test pod, and expected nvidia-smi output confirming memory
isolation.

Adds quick-path as the first entry in the get-started sidebar section
so users land on the fastest path before the full deployment guide.

Closes Project-HAMi#412.

Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented May 29, 2026

Deploy Preview for project-hami ready!

Name Link
🔨 Latest commit f85638d
🔍 Latest deploy log https://app.netlify.com/projects/project-hami/deploys/6a1a026d3354d90007261d2b
😎 Deploy Preview https://deploy-preview-425--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
Copy link
Copy Markdown
Contributor

hami-robot Bot commented May 29, 2026

[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 wawa0210 May 29, 2026 20:23
@hami-robot hami-robot Bot added the size/L label May 29, 2026
Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
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.

[docs/quickstart] Create a 5-minute quick start path

1 participant