Skip to content
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: (#3137) show 'apply yaml' either from stdin, or from file using… #3223

Merged
merged 3 commits into from
Apr 24, 2024

Conversation

eitansuez
Copy link
Contributor

… tabs

What type of PR is this?

  • docs: retrofits tasks to provide yaml in two forms, using tabs: 1. a command can be copy-pasted to apply directly with kubectl, and 2. show the yaml, useful for reviewing the configuration and saving to a file.

What this PR does / why we need it:

this is a convenience in the docs. oftentimes it's really nice to be able to show yaml with code highlighting for ease of legibility, but it's also convenient to provide a kubectl apply -f command that can copy-paste directly into the shell.

Which issue(s) this PR fixes:
Fixes #3137

@eitansuez eitansuez requested a review from a team as a code owner April 19, 2024 20:48
@eitansuez eitansuez marked this pull request as draft April 19, 2024 20:48
@eitansuez
Copy link
Contributor Author

change applied to just one task: "http request headers". let me know what you think and i'll start working on retrofitting all other tasks.

@eitansuez eitansuez marked this pull request as ready for review April 19, 2024 22:05
arkodg
arkodg previously approved these changes Apr 19, 2024
Copy link
Contributor

@arkodg arkodg left a comment

Choose a reason for hiding this comment

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

LGTM thanks !

@eitansuez
Copy link
Contributor Author

LGTM thanks !

i had to push a lint fix. it looks like it might have invalidated your review?

Eitan Suez added 3 commits April 23, 2024 09:31
…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>
@eitansuez eitansuez force-pushed the docs-show-apply-yaml-in-tabs branch from 5479b43 to c73859a Compare April 23, 2024 14:31
Copy link
Contributor

@arkodg arkodg left a comment

Choose a reason for hiding this comment

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

LGTM thanks !

@arkodg arkodg requested review from a team April 24, 2024 01:21
@zirain zirain merged commit ae58b47 into envoyproxy:main Apr 24, 2024
20 checks passed
@eitansuez eitansuez deleted the docs-show-apply-yaml-in-tabs branch April 24, 2024 02:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: yaml artifacts in guides should code-highlight
3 participants