DandyDeveloper / charts

Various helm charts migrated from [helm/stable] due to deprecation
https://dandydeveloper.github.io/charts
Apache License 2.0
157 stars 145 forks source link

docs(redis-ha): Introduce helm-docs for values documentation #280

Closed mkilchhofer closed 1 week ago

mkilchhofer commented 6 months ago

What this PR does / why we need it:

Manually ensuring proper documentation for all parameters is almost impossible and also in this redis-ha helm chart a plenty of variables were undocumented.

The helper utility helm-docs has a wide adoption inside CNCF projects.

Which issue this PR fixes

none

Special notes for your reviewer:

I already templated the chart before my change and after my change

$ helm template . > rendered-master.yaml

$ git co -
Switched to branch 'feature/redis-ha_introduce_helm-docs'
Your branch is up to date with 'origin/feature/redis-ha_introduce_helm-docs'.

$ helm template . > rendered-feature_redis-ha_introduce_helm-docs.yaml

$ diff -u rendered-master.yaml rendered-feature_redis-ha_introduce_helm-docs.yaml
$ echo $?
0

This should verify that we do not introduce a regression with this docs change.

Checklist

[Place an '[x]' (no spaces) in all applicable fields. Please remove unrelated fields.]

DandyDeveloper commented 5 months ago

Helm docs is new to me! Let me go through this quickly so I can approve knowing I'm up to speed!

mkilchhofer commented 3 months ago

@DandyDeveloper friendly reminder

mkilchhofer commented 3 weeks ago

@DandyDeveloper another friendly ping

Are You There GIF

DandyDeveloper commented 3 weeks ago

I am here! Just neglected my duties this past couple of months. Sorry!