-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Problem
The README.md is significantly out of date and doesn't reflect the actual state of the repository.
Issues Found
1. Chart List is Wrong
Current README states:
| Chart | Description |
|---|---|
| holmes | OLM for Kubernetes |
| mdbook-htmx | HTMX-enhanced documentation backend |
Actual charts in repository:
| Chart | Description | Status |
|---|---|---|
| cloudflared | Cloudflare Tunnel client | MISSING from README (main chart!) |
| olm | OLM for Kubernetes | Listed as "holmes" incorrectly |
| mdbook-htmx | MDBook backend | Correct |
| test-workflow | Test chart for CI | Internal, shouldn't be listed |
2. Version Numbers are Static
The version numbers in the table are hardcoded (0.1.0) and don't reflect current versions.
3. Example Commands Reference Wrong Charts
helm install my-olm oci://ghcr.io/arustydev/charts/holmes --version 0.1.0Should reference actual chart names and current versions.
Recommended Changes
- Add cloudflared to the chart list (it's the main chart!)
- Fix "holmes" → "olm"
- Consider auto-generating the chart table from Chart.yaml files
- Update example commands to use correct chart names
Related
- Part of documentation refresh for chart release workflows
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation