Skip to content

Change Helm reference --set formatting#24944

Merged
ptgott merged 2 commits intomasterfrom
paul.gottschling/9686-set
May 2, 2023
Merged

Change Helm reference --set formatting#24944
ptgott merged 2 commits intomasterfrom
paul.gottschling/9686-set

Conversation

@ptgott
Copy link
Copy Markdown
Contributor

@ptgott ptgott commented Apr 20, 2023

Closes #9686

Since the --set flag examples aren't commands, this change removes the shell prompts and changes code fence labels from code to text.

Closes #9686

Since the `--set` flag examples aren't commands, this change removes the
shell prompts and changes code fence labels from `code` to `text`.
@ptgott ptgott force-pushed the paul.gottschling/9686-set branch from 582fb68 to b1b3ffb Compare April 25, 2023 21:20
@hugoShaka
Copy link
Copy Markdown
Contributor

hugoShaka commented Apr 27, 2023

Could we just drop them? This --set syntax is awkward, does not suit complex configurations well, and gives us more maintenance work. IMO we can expect the few users who need it to use CLI flags to be able to translate from values.yaml to --set. If they are not, they should not use the --set flags as they'll likely not keep what they put and end up with an unmanageable release.

Keep the values.yaml examples. Used the following script to generate the
change:

files="$(find docs/pages/reference/helm-reference -name "*.mdx")";

for i in $(echo "$files"); do
    tmp=$(awk 'BEGIN{yaml=""}
    /<Tabs>/{t=1}
    t==1 && /```yaml/{y=1; yaml="`values.yaml` example:\n\n"}
    y==1{yaml = (yaml "\n" $0)}
    y==1 && /```$/{y=0; print yaml; yaml=""}
    t==1 && /<\/Tabs/{t=0; next}
    t==0{print $0 }' $i)
    echo "$tmp" > $i;
done
@ptgott
Copy link
Copy Markdown
Contributor Author

ptgott commented May 2, 2023

@hugoShaka Sounds good! I've made the change in 3a7472a

Copy link
Copy Markdown
Contributor

@hugoShaka hugoShaka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉

@ptgott ptgott added this pull request to the merge queue May 2, 2023
Merged via the queue into master with commit 4727bc6 May 2, 2023
@ptgott ptgott deleted the paul.gottschling/9686-set branch May 2, 2023 19:38
@public-teleport-github-review-bot
Copy link
Copy Markdown

@ptgott See the table below for backport results.

Branch Result
branch/v11 Failed
branch/v12 Failed
branch/v13 Create PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Edit the formatting of --set examples in our Helm references

3 participants