Deduplicating documentation about charts HOT 5 CLOSED

Is there a common standard as to the minimal type of documentation that should be done within the helm chart itself?

from charts.

So i found a pivot point as what you said made me do some digging. Instead of removing docs i went the stitch together route. Its not done but its close. 7d17666

Command is

gomplate -t ../_helpers.tmpl -c Chart=Chart.yaml -c Values=values.yaml -f ../README.md.tmpl 

if you are in the chart's top level dir.

from charts.

IMO the git repo directory for each chart should be the 'source of truth'. External tooling like artifacthub (or other third-party chart indexers) should reference the chart's readme instead of the other-way-around.

We should be cautious about striving too hard for some form of elegant de-duplication effort at the expense of readability & usability. Something like 7d17666 looks like a good starting point for generating initial documentation for a chart, but it would be a mistake, IMO, to adopt a rigid (or overly complicated) standard for README documentation that would prevent adding useful information to a specific chart's README.

from charts.

@billimek I was thinking some kind of modular approach where the template just generated the repo-wide or widely used sections, and then had parts that would be ad-hoc from each section to add whatever you wanted e.g. a file named UPGRADING.md with additional upgrade concerns like whats in some charts and it would read the file in as-is. Would this satisfy your concerns for useful uniqueness? If so what other ad-hoc sections should be injectable? I initially assumed additional description, installing, upgrading, and notes.

from charts.

I think we should move this discussion over to

https://github.com/k8s-at-home/charts/discussions

from charts.