-
Notifications
You must be signed in to change notification settings - Fork 147
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
docs(redis-ha): Introduce helm-docs for values documentation #280
Merged
DandyDeveloper
merged 7 commits into
DandyDeveloper:master
from
mkilchhofer:feature/redis-ha_introduce_helm-docs
Nov 6, 2024
Merged
docs(redis-ha): Introduce helm-docs for values documentation #280
DandyDeveloper
merged 7 commits into
DandyDeveloper:master
from
mkilchhofer:feature/redis-ha_introduce_helm-docs
Nov 6, 2024
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
mkilchhofer
force-pushed
the
feature/redis-ha_introduce_helm-docs
branch
from
May 22, 2024 20:17
560d858
to
39658c2
Compare
4 tasks
Helm docs is new to me! Let me go through this quickly so I can approve knowing I'm up to speed! |
Signed-off-by: Marco Maurer <[email protected]>
mkilchhofer
force-pushed
the
feature/redis-ha_introduce_helm-docs
branch
from
May 26, 2024 15:01
39658c2
to
b598c55
Compare
@DandyDeveloper friendly reminder |
@DandyDeveloper another friendly ping |
I am here! Just neglected my duties this past couple of months. Sorry! |
Signed-off-by: Aaron Layfield <[email protected]>
Signed-off-by: Aaron Layfield <[email protected]>
Signed-off-by: Aaron Layfield <[email protected]>
Signed-off-by: Aaron Layfield <[email protected]>
DandyDeveloper
previously approved these changes
Nov 5, 2024
Signed-off-by: Aaron Layfield <[email protected]>
DandyDeveloper
approved these changes
Nov 6, 2024
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.
What this PR does / why we need it:
Manually ensuring proper documentation for all parameters is almost impossible and also in this redis-ha helm chart a plenty of variables were undocumented.
The helper utility helm-docs has a wide adoption inside CNCF projects.
Which issue this PR fixes
none
Special notes for your reviewer:
I already templated the chart before my change and after my change
This should verify that we do not introduce a regression with this docs change.
Checklist
[Place an '[x]' (no spaces) in all applicable fields. Please remove unrelated fields.]
[stable/mychartname]
)