[no-relnote] Improve helm chart documentation #261
Conversation
This file contains 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
Add helm-docs workflow to auto-generate README.md for helm charts.
Chart.yaml is updated with the correct description Signed-off-by: faganihajizada <[email protected]>
The controller is designed to run as a single instance per cluster. Please avoid running multiple instances of the controller in the same cluster at same time. Signed-off-by: faganihajizada <[email protected]>
Signed-off-by: faganihajizada <[email protected]>
faganihajizada
changed the title
|
Maybe also mention #257 ? |
sure @ArangoGutierrez. Do you want me to add it to the README template? feel free to commit to this PR directly if you want to. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add GitHub action to auto-generate README file with Helm-docs