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 kubectl built-in help #1632

Open
5 tasks
Parkofadown opened this issue Aug 7, 2024 · 16 comments
Open
5 tasks

Improve kubectl built-in help #1632

Parkofadown opened this issue Aug 7, 2024 · 16 comments
Labels
area/kubectl priority/backlog Higher priority than priority/awaiting-more-evidence. sig/cli Categorizes an issue or PR as relevant to SIG CLI. sig/docs Categorizes an issue or PR as relevant to SIG Docs. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@Parkofadown
Copy link

Parkofadown commented Aug 7, 2024

This is an umbrella issue to manage improvement requests in single issue.

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Aug 7, 2024
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the triage/accepted label.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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-sigs/prow repository.

@sftim
Copy link
Contributor

sftim commented Aug 7, 2024

Please bear https://kubernetes.io/docs/reference/kubectl/generated/kubectl_cordon/#auto-generated-edit-notice in mind @Parkofadown

We can transfer the issue for you to the right place (Prow command /transfer kubectl) if you like.

@sftim
Copy link
Contributor

sftim commented Aug 7, 2024

/sig cli

@k8s-ci-robot k8s-ci-robot added the sig/cli Categorizes an issue or PR as relevant to SIG CLI. label Aug 7, 2024
@Parkofadown
Copy link
Author

Parkofadown commented Aug 7, 2024

Please bear https://kubernetes.io/docs/reference/kubectl/generated/kubectl_cordon/#auto-generated-edit-notice in mind @Parkofadown

We can transfer the issue for you to the right place (Prow command /transfer kubectl) if you like.

@sftim Thank you , what is a Prow command /transfer kubectl ?

@sftim
Copy link
Contributor

sftim commented Aug 7, 2024

We have a bot to help us manage issues. It's sufficiently advanced that I can:
/transfer kubectl

@k8s-ci-robot k8s-ci-robot transferred this issue from kubernetes/website Aug 7, 2024
@sftim
Copy link
Contributor

sftim commented Aug 7, 2024

/sig docs
/area kubectl documentation

@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Aug 7, 2024
@k8s-ci-robot
Copy link
Contributor

@sftim: The label(s) area/documentation cannot be applied, because the repository doesn't have them.

In response to this:

/sig docs
/area kubectl documentation

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-sigs/prow repository.

@sftim
Copy link
Contributor

sftim commented Aug 7, 2024

@Parkofadown this issue has a new URL now, but it's still in a way the “same” issue

@ardaguclu
Copy link
Member

This is a doc improvement which is a good thing
/triage accepted
/priority backlog
@Parkofadown would you like to open a PR?

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. priority/backlog Higher priority than priority/awaiting-more-evidence. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Aug 8, 2024
@Parkofadown
Copy link
Author

This is a doc improvement which is a good thing /triage accepted /priority backlog @Parkofadown would you like to open a PR?

@ardaguclu I would love to open a PR but I do not know your timeline for improvement. I currently work full-time 7:30AM - 3:30 PM EST and provide for 5 people in my household after that.

@ardaguclu
Copy link
Member

Also this #1634

@sftim
Copy link
Contributor

sftim commented Aug 8, 2024

/retitle Improve kubectl built-in help

@k8s-ci-robot k8s-ci-robot changed the title Improvement for k8s.io/docs/reference/kubectl/generated/kubectl_cordon/ Improve kubectl built-in help Aug 8, 2024
@ardaguclu
Copy link
Member

and this #1639

@ah8ad3
Copy link
Member

ah8ad3 commented Aug 20, 2024

I suggest if you agree we can make this good first issue, for some one that wants to fix them.

@sftim
Copy link
Contributor

sftim commented Aug 20, 2024

Umbrella issues don't make good first issues; see https://www.kubernetes.dev/docs/guide/help-wanted/#good-first-issue

@Parkofadown
Copy link
Author

I don't agree that this is a good first issue. Someone would have to know how to program a terminal and be very careful to not make a mistake

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/kubectl priority/backlog Higher priority than priority/awaiting-more-evidence. sig/cli Categorizes an issue or PR as relevant to SIG CLI. sig/docs Categorizes an issue or PR as relevant to SIG Docs. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
Status: Needs Triage
Development

No branches or pull requests

5 participants