Reloader icon indicating copy to clipboard operation
Reloader copied to clipboard

Correct documentation for in repo helm chart

Open techdragon opened this issue 4 years ago • 4 comments

Since this has transitioned to using an in repo helm chart, the helm chart documentation should be checked, and documented. The current helm chart in this repo, seems to be built from several layers of templating which makes it harder to understand, and the correctness of this documentation all the more essential.

  • The last Helm Stable repo version had the appropriate section documenting the helm chart configuration values. https://github.com/helm/charts/tree/master/stable/reloader#usage which appears completely missing from anywhere inside this repo.
  • The documentation should probably be located with the rest of the helm documentation https://github.com/stakater/Reloader#helm-charts but this appears to just contain the non-configuration related information from the equivalent section in the older helm chart readme https://github.com/helm/charts/tree/master/stable/reloader#helm-charts.

techdragon avatar Apr 21 '20 17:04 techdragon

@techdragon PR is more than welcome; please create one

rasheedamir avatar Apr 24 '20 18:04 rasheedamir

Is anyone more familiar with the project, and the templating in particular, able to confirm if the helm chart docs are still correct? I haven't even deployed the project yet myself (I came across this project while reviewing tools for a Kubernetes infrastructure overhaul) and I won't feel confident writing a PR until I've reverse engineered the templating. ( Which I may end up needing to do if this isn't already fixed and reloader is added to our infrastructure 😅)

techdragon avatar Apr 25 '20 15:04 techdragon

sure no problem @techdragon

@usamaahmadkhan can you please confirm?

rasheedamir avatar Apr 25 '20 20:04 rasheedamir

@techdragon There are minor changes to the Values section in stable/reloader as compared to the in-repo chart values. The differences can be viewed on the values.yaml file. Kindly see the differences in deployments/kubernetes/chart/reloader/values.yaml here

usamaahmadkhan avatar Apr 27 '20 05:04 usamaahmadkhan