-
Notifications
You must be signed in to change notification settings - Fork 360
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: yaml artifacts in guides should code-highlight #3137
Comments
/assign @yuluo-yx |
fyi, i have an implementation i'll submit shortly via a PR. |
got it. |
…ctl apply -f - <<EOF part (envoyproxy#3137) Signed-off-by: Eitan Suez <eitan@tetrate.io>
hey @eitansuez, can we also support applying via |
that's a good idea. let me work on that.. |
waiting on tabs capability to get merged, and then the plan will be to display two tabs - one with a command to apply the resource directly to the cluster, the other provides just the resource that a user can copy and save to a file before applying. |
…file using tabs Signed-off-by: Eitan Suez <eitan@tetrate.io>
…ets using tabs Signed-off-by: Eitan Suez <eitan@tetrate.io>
…inting Signed-off-by: Eitan Suez <eitan@tetrate.io>
…file using tabs Signed-off-by: Eitan Suez <eitan@tetrate.io>
…ets using tabs Signed-off-by: Eitan Suez <eitan@tetrate.io>
…inting Signed-off-by: Eitan Suez <eitan@tetrate.io>
#3223) * docs: (#3137) show 'apply yaml' either from stdin, or from file using tabs Signed-off-by: Eitan Suez <eitan@tetrate.io> * docs: (#3137) retrofit remaining 'kubectl apply' yaml snippets using tabs Signed-off-by: Eitan Suez <eitan@tetrate.io> * docs: (#3137) surrounds shell blocks with blank lines for linting Signed-off-by: Eitan Suez <eitan@tetrate.io> --------- Signed-off-by: Eitan Suez <eitan@tetrate.io>
Description:
most of the tasks combine [a] displaying yaml to be applied with [b] applying it to the cluster using the shorthand:
this is great and convenient copy-paste.
but if the resources were presented first as bona-fide yaml, you'd get better yaml highlighting/color-coding, which makes it easier for the reader to review the content.
it also gives the reader an opportunity to copy just the yaml if they want to save these CRs on their file system and study them before doing a kubectl apply.
(also if the reader is not using the bash shell, that command might not work)
suggestion: revise all instructions in the user guides / tasks such that we display yaml instead, along with an instruction to kubectl apply the resource[s] to the cluster:
The text was updated successfully, but these errors were encountered: