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

Improve clarity of kubectl Cheat Sheet with version information #40582

Closed
rainbowBPF2 opened this issue Apr 10, 2023 · 9 comments · Fixed by #40912
Closed

Improve clarity of kubectl Cheat Sheet with version information #40582

rainbowBPF2 opened this issue Apr 10, 2023 · 9 comments · Fixed by #40912
Assignees
Labels
language/en Issues or PRs related to English language priority/backlog Higher priority than priority/awaiting-more-evidence. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@rainbowBPF2
Copy link

Feedback a confusing point about kubectl command on page:
https://kubernetes.io/docs/reference/kubectl/cheatsheet/#formatting-output

image

"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.

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Apr 10, 2023
@T-Lakshmi
Copy link
Contributor

Page: https://kubernetes.io/docs/reference/kubectl/cheatsheet/#formatting-output
/language en
/kind suggestion

@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Apr 10, 2023
@k8s-ci-robot
Copy link
Contributor

@T-Lakshmi: The label(s) kind/suggestion cannot be applied, because the repository doesn't have them.

In response to this:

Page: https://kubernetes.io/docs/reference/kubectl/cheatsheet/#formatting-output
/language en
/kind suggestion

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.

@dipesh-rawat
Copy link
Member

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.
To improve clarity, the cheat sheet could integrate details from https://kubernetes.io/docs/home/supported-doc-versions/ and provide explicit links within the content body to the other available versions. This approach would be more effective than simply relying on the version selector in the top navigation. Would folks consider this suggestion beneficial?

@dipesh-rawat
Copy link
Member

/retitle Improve clarity of kubectl Cheat Sheet with version information

@k8s-ci-robot k8s-ci-robot changed the title kubectl Cheat Sheet Improve clarity of kubectl Cheat Sheet with version information Apr 10, 2023
@sftim
Copy link
Contributor

sftim commented Apr 11, 2023

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:

If you are running a version of Kubernetes other than v1.26, check the documentation for that version.

we could replace that text with an even more helpful shortcode.

@sftim
Copy link
Contributor

sftim commented Apr 17, 2023

We could add a comment that this is accurate for this version of the docs.

/priority backlog

@k8s-ci-robot k8s-ci-robot added the priority/backlog Higher priority than priority/awaiting-more-evidence. label Apr 17, 2023
@sftim
Copy link
Contributor

sftim commented Apr 17, 2023

I recommend the simple comment approach. We can still use version shortcodes, eg {{< skew currentVersion >}} in the comment.
/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Apr 17, 2023
@mrgiles
Copy link
Contributor

mrgiles commented Apr 30, 2023

/assign

@mrgiles
Copy link
Contributor

mrgiles commented May 1, 2023

FYI @sftim

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
language/en Issues or PRs related to English language priority/backlog Higher priority than priority/awaiting-more-evidence. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants