fix helm chart's README #1555
Merged
fix helm chart's README #1555
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
janeklb
force-pushed
the
jlb/improve-chart-readme
branch
from
38191a8 to
1bcdcf1
Compare
Slach
requested changes
Nov 8, 2024
|
could you resolve conflicts with 0.24.1 branch? and could you run |
I intentionally did not set the PR's base to |
The helm chart's README is illegible in its current state. This commit adjusts the `values.yaml` file used to generate the usage table in the README.md file such that it correctly (as intended) renders a short message in place of the actual default value for the `configs` field Signed-off-by: Janek Lasocki-Biczysko <[email protected]>
janeklb
force-pushed
the
jlb/improve-chart-readme
branch
from
1bcdcf1 to
93fe75f
Compare
Done |
janeklb
commented
Nov 8, 2024
Slach
approved these changes
Nov 8, 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.
The helm chart's README is illegible in its current state (this is almost entirely due to the broken
configsrow in the values table).This commit adjusts the
values.yamlfile used to generate the usage table in theREADME.mdfile such that, after running./dev/generate_helm_chart.sh, it correctly (as intended) renders a short message in place of the actual default value for theconfigsfieldNote to reviewer:
look ...withcheck ...(more grammatically correct)./dev/generate_helm_chart.sh(indirectly) removes additional blank lines. This seems to be ayqissue. There are some workarounds for it (eg. yq write strips completely blank lines from the output mikefarah/yq#515); however, I didn't bother implementing any. What do you think?Important items to consider before making a Pull Request
Please check items PR complies to:
next-releasebranch, not intomasterbranch1. More info1 If you feel your PR does not affect any Go-code or any testable functionality (for example, PR contains docs only or supplementary materials), PR can be made into
masterbranch, but it has to be confirmed by project's maintainer.