search

open-telemetry / opentelemetry-helm-charts

OpenTelemetry Helm Charts
https://opentelemetry.io
Apache License 2.0
364 stars 445 forks source link

Generate helm-docs readme for all charts #430

Open Allex1 opened 1 year ago

Allex1 commented 1 year ago

@TylerHelmuth @dmitryax I was thinking to add helm-docs for all of our chart like Grafana charts have for example. We use them in all charts and I find it very useful. I can also add contributing instructions for users to keep them in sync when they make changes in values.yaml. WDYT ?

dmitryax commented 1 year ago

Sounds good to me 👍

TylerHelmuth commented 1 year ago

Agreed. Id say we should add something to the workflows that enforces things stay in sync, like we do with examples.

Saki042 commented 3 weeks ago

@TylerHelmuth , Can you confirm whether this enhancement requirement is still open ?

TylerHelmuth commented 3 weeks ago

Yes this would still be helpful

Saki042 commented 3 weeks ago

@Allex1 / @TylerHelmuth , Can you elaborate more on the issue and I am new to open source so it would be really helpful if you provide me some guide regarding changes. Can you please assign it to me?