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

Automate Helm Doc generation from charts #7639

Closed
shubham1172 opened this issue Mar 20, 2024 · 2 comments
Closed

Automate Helm Doc generation from charts #7639

shubham1172 opened this issue Mar 20, 2024 · 2 comments
Labels
kind/enhancement stale Issues and PRs without response

Comments

@shubham1172
Copy link
Member

In what area(s)?

/area runtime

/area operator

/area placement

/area docs

/area test-and-release

Describe the feature

Today we maintain our documentation for Dapr Helm charts manually - https://github.com/dapr/dapr/commits/master/charts/dapr/README.md

This is a proposal to instead use a project like https://github.com/norwoodj/helm-docs, to simply generate the docs for us.
This means no more manually updating the README.md, and:

  • values.yaml files will be well documented and the source of truth
  • README.md will always be in sync with the Charts

Release Note

RELEASE NOTE: ADD automatic Helm Charts documentation generation

@dapr-bot
Copy link
Collaborator

This issue has been automatically marked as stale because it has not had activity in the last 60 days. It will be closed in the next 7 days unless it is tagged (pinned, good first issue, help wanted or triaged/resolved) or other activity occurs. Thank you for your contributions.

@dapr-bot dapr-bot added the stale Issues and PRs without response label May 19, 2024
@dapr-bot
Copy link
Collaborator

This issue has been automatically closed because it has not had activity in the last 67 days. If this issue is still valid, please ping a maintainer and ask them to label it as pinned, good first issue, help wanted or triaged/resolved. Thank you for your contributions.

@dapr-bot dapr-bot closed this as not planned Won't fix, can't repro, duplicate, stale May 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement stale Issues and PRs without response
Projects
None yet
Development

No branches or pull requests

2 participants