apache / apache/pulsar-helm-chart

README missing in helm chart distribution

Open
#328 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Shell
Stars
240
Forks
260
Avg merge
4h 12m
Merged PRs (30d)
1

Description

**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](https://user-images.githubusercontent.com/5681880/197770333-e18cb515-faf2-4a09-b0f2-18a2c1b64561.png)

Contributor guide

No contributing guide indexed for this repository

Research direction

Inspect the Helm chart distribution and consult the Helm chart README documentation linked in the issue. Use `helm show readme` to verify the packaged chart exposes the README, and confirm that Artifact Hub displays it for the Apache Pulsar chart.

Written by the indexing model from the issue text.

Assessment

Tech stack
helm, kubernetes
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.