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

feat: generated Helm documentation #335

Merged
merged 1 commit into from
Sep 30, 2024
Merged

Conversation

aslafy-z
Copy link
Collaborator

@aslafy-z aslafy-z commented Jul 16, 2024

Preview at https://github.com/stakater/application/blob/feat/generated-readme/README.md

  • Generate README.md with https://github.com/norwoodj/helm-docs
  • Add pre-commit hook and GitHub Action run to validate README
  • Document the whole values file
  • Move some defaults from templates to values
  • Set certificate.issuerRef.group to cert-manager.io

Thanks to norwoodj/helm-docs#260, we will soon be able to render a bit better some of the default values.

Fixes #242

Copy link

@aslafy-z validation successful`

@aslafy-z aslafy-z force-pushed the feat/generated-readme branch 2 times, most recently from db29820 to ba729be Compare July 17, 2024 12:59
@aslafy-z aslafy-z marked this pull request as ready for review July 25, 2024 16:04
@aslafy-z aslafy-z force-pushed the feat/generated-readme branch 5 times, most recently from 0965b2a to 27ef4ff Compare July 25, 2024 16:18
@rasheedamir
Copy link
Member

@karl-johan-grahn @d3adb5 can you guys review it?

Signed-off-by: GitHub <noreply@github.com>
@rasheedamir
Copy link
Member

looks good to me! great work @aslafy-z

@aslafy-z aslafy-z merged commit 31904e3 into master Sep 30, 2024
3 checks passed
@aslafy-z aslafy-z deleted the feat/generated-readme branch September 30, 2024 15:52
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.

Automate helm documentation update
4 participants