[STORY] Helm NOTES that fit the cluster, and uninstall docs that list what stays behind

Open Beginner friendly
#2,420 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
82/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
helm, kubernetes, markdown

Research direction

Read charts/llmkube/templates/NOTES.txt, charts/llmkube/values.yaml, charts/llmkube/README.md, and the quickstart docs page. Render the chart with default values using helm template charts/llmkube | head, then run helm unittest charts/llmkube. Done when default NOTES omit GPU-generation-specific requirements, uninstall docs list the remaining CRDs and per-namespace PVC and removal steps, and the quickstart explains the PVC created on first deploy and its size.

Written by the indexing model from the issue text.

Description

documentation helm priority/low size/small

Goal

Make the chart's install output and uninstall instructions fit the cluster the user has, and say what stays behind.

Definition of done

  • Observable: helm install on a CPU-only cluster prints a short NOTES.txt (the hardware-specific platform floors are behind a value or a link); the chart README's uninstall section lists the CRDs and the per-namespace llmkube-model-cache PVC that remain and how to remove them; the quickstart mentions that the first deploy creates that PVC and its size.
  • Negative: NOTES.txt on a default install does not print GPU-generation-specific requirements.

Scope

  • charts/llmkube/templates/NOTES.txt, charts/llmkube/values.yaml (one value if needed), charts/llmkube/README.md, the quickstart docs page.

Out of scope

  • Automatic cleanup of the cache PVC (#2169).

Consumers and surfaces touched

  • Helm install output; one optional chart value.

Verification

helm template charts/llmkube | head
helm unittest charts/llmkube

Falsification

  • Edit: render NOTES.txt with the default values.
  • Expected failure: none of the GPU-generation platform floors appear.

Risks

  • none
Dominant language
Go
Stars
232
Forks
37
Avg merge
21h 42m
Merged PRs (30d)
244

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from defilantech/LLMKube

All issues in defilantech/LLMKube

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.