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

Use helm-docs to auto-generate documentation for our chart #1677

Merged
merged 4 commits into from
Nov 16, 2023
Merged

Conversation

JAORMX
Copy link
Contributor

@JAORMX JAORMX commented Nov 16, 2023

This allows us to auto-generate documentation including the relevant
values to configure. A CI job will keep it in sync.

This allows us to auto-generate documentation including the relevant
values to configure. A CI job will keep it in sync.
Copy link
Member

@rdimitrov rdimitrov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Should we add helm docs to the 'make bootstrap' tools too?

teodor-yanev
teodor-yanev previously approved these changes Nov 16, 2023
@JAORMX
Copy link
Contributor Author

JAORMX commented Nov 16, 2023

@rdimitrov done

rdimitrov
rdimitrov previously approved these changes Nov 16, 2023
@JAORMX JAORMX merged commit 733cdf7 into main Nov 16, 2023
13 checks passed
@JAORMX JAORMX deleted the helm-docs branch November 16, 2023 09:52
jhrozek pushed a commit to jhrozek/minder that referenced this pull request Nov 16, 2023
…ec#1677)

* Use `helm-docs` to auto-generate documentation for our chart

This allows us to auto-generate documentation including the relevant
values to configure. A CI job will keep it in sync.

* Add `helm-docs` to bootstrap

* fix ci job

* more go.mod fixes
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

Successfully merging this pull request may close these issues.

3 participants