Feat ogdc helm readme #45
Open
+236
−57
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update docs to support bitnami autogen tool
add README.md for helm autogen with bitnami readme generator
pre-commit set up for README generator
trey-stafford
approved these changes
Dec 22, 2025
Member
trey-stafford
left a comment
trey-stafford
left a comment
There was a problem hiding this comment.
This is great!
My only suggestion would be to add something to the front-page README about this. It would be nice to call this out:
- In the installation section, esp. for production. E.g., "Refer to the
helm/README.mdfor information about configuring the installation". - Some kind of note for contributors, so that they know to run
pre-commit installand know that this file is auto-generated and not managed by hand.
rmarow
approved these changes
Dec 22, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
rel: #44
This uses the bitnami readme generator tool to auto generate
READMEfor helmvalues.yaml