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

README missing in helm chart distribution #328

Open
hpvd opened this issue Oct 25, 2022 · 1 comment
Open

README missing in helm chart distribution #328

hpvd opened this issue Oct 25, 2022 · 1 comment

Comments

@hpvd
Copy link

hpvd commented Oct 25, 2022

Is your feature request related to a problem? Please describe.

the helm chart seems not to include a README

quick check:
artifacthub.io shows READMEs if available:

pulsar: no README
https://artifacthub.io/packages/helm/apache/pulsar

example with included README:
kube prometheus stack
https://artifacthub.io/packages/helm/prometheus-community/kube-prometheus-stack

Describe the solution you'd like
ad README to helm chart (file/url)

background: https://helm.sh/docs/topics/charts/#chart-license-readme-and-notes
check with https://helm.sh/docs/helm/helm_show_readme/

Describe alternatives you've considered
none

Additional context
none

2022-10-25_14h14_16

@hpvd hpvd changed the title readme missing in helm chart README missing in helm chart Oct 25, 2022
@michaeljmarshall michaeljmarshall changed the title README missing in helm chart README missing in helm chart distribution Nov 4, 2022
@michaeljmarshall
Copy link
Member

michaeljmarshall commented Nov 4, 2022

Here is documentation on adding the README to the distribution: https://helm.sh/docs/topics/charts/. We just need to put it in charts/pulsar/.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants