Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write a set of best practices for writing Helm chart documentation #386

Open
osg-grafana opened this issue Nov 22, 2023 · 4 comments
Open
Labels
type/docs Docs Squad label used across all Grafana Labs repos

Comments

@osg-grafana
Copy link
Contributor

Grafana Labs supports 20+ Helm charts across projects and products. Thus far, there is no common set of best practices for writing them.

@osg-grafana osg-grafana added the type/docs Docs Squad label used across all Grafana Labs repos label Nov 22, 2023
@jdbaldry
Copy link
Member

I don't know who would be best to write these or if there is justification for general guidance for these kinds of docs.

@BeverlyJaneJ I know you are working on the Kubernetes Monitoring Helm chart documentation. Do you feel like it would be worthwhile to distinguish the practice of writing Helm chart documentation from the rest of our docs?

@BeverlyJaneJ
Copy link
Contributor

@jdbaldry I don't think I know enough to comment on this. What I'm trying to head off (by creating an overview doc that lives within K8s Mon docs) is the devs spending too much time on POV questions after someone has misconfigured the chart in an attempted deployment.

@jdbaldry
Copy link
Member

jdbaldry commented Feb 1, 2024

Thanks for taking a look :)

I'll bring this to the team before I close this issue for now.

@clayton-cornell
Copy link
Contributor

Agent uses Helm Chart too in the K8s deployments... but the docs here are how Agent uses Helm vs core Helm Chart docs.

@jdbaldry jdbaldry changed the title Docs: Write a set of best practices for writing Helm chart documentation Write a set of best practices for writing Helm chart documentation Feb 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Docs Squad label used across all Grafana Labs repos
Projects
None yet
Development

No branches or pull requests

4 participants