aRustyDev / aRustyDev/helm-charts

docs: README.md is outdated - missing charts and incorrect references

Open
#149 0 comments 0 reactions 1 assignee Claimed by @aRustyDev View on GitHub
documentation
Dominant language
Go Template
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

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
```bash
helm install my-olm oci://ghcr.io/arustydev/charts/holmes --version 0.1.0
```
Should reference actual chart names and current versions.

## Recommended Changes

1. Add cloudflared to the chart list (it's the main chart!)
2. Fix "holmes" → "olm"
3. Consider auto-generating the chart table from Chart.yaml files
4. Update example commands to use correct chart names

## Related
- Part of documentation refresh for chart release workflows

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.