-
Notifications
You must be signed in to change notification settings - Fork 14.6k
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
Improve clarity of kubectl Cheat Sheet with version information #40582
Comments
Page: https://kubernetes.io/docs/reference/kubectl/cheatsheet/#formatting-output |
@T-Lakshmi: The label(s) In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
In my opinion, the cheat sheet is accurate for Kubernetes v1.26. However, if someone needs to refer to older documentation, they can access it by using the version selector option in the navigation bar. |
/retitle Improve clarity of kubectl Cheat Sheet with version information |
I'd like to see a shortcode that renders as helper text to steer people to the right documentation, and a link to available versions. See https://kubernetes.io/docs/setup/production-environment/container-runtimes/ for an example where I'd use this:
we could replace that text with an even more helpful shortcode. |
We could add a comment that this is accurate for this version of the docs. /priority backlog |
I recommend the simple comment approach. We can still use version shortcodes, eg |
/assign |
FYI @sftim |
Feedback a confusing point about kubectl command on page:
https://kubernetes.io/docs/reference/kubectl/cheatsheet/#formatting-output
"kubectl events " command seems just available in k8s-v1.26 release version, while below v1.26 not work yet.
so a brief tip or comment on the page will be easy to understand.
FYI.
The text was updated successfully, but these errors were encountered: