kubectl icon indicating copy to clipboard operation
kubectl copied to clipboard

Improve kubectl built-in help

Open Parkofadown opened this issue 1 year ago • 17 comments
trafficstars

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

### Tasks
- [ ] [Improvement for k8s.io/docs/reference/kubectl/generated/kubectl_cordon/](https://github.com/kubernetes/kubectl/issues/1632)
- [ ] [Improvement for k8s.io/docs/reference/kubectl/generated/kubectl_events/](https://github.com/kubernetes/kubectl/issues/1635)
- [ ] [Improvement for k8s.io/docs/reference/kubectl/generated/kubectl_kustomize/](https://github.com/kubernetes/kubectl/issues/1636)
- [ ] [Improvement for k8s.io/docs/reference/kubectl/generated/kubectl_label/](https://github.com/kubernetes/kubectl/issues/1637)
- [ ] [Improve behavior of kubectl options](https://github.com/kubernetes/kubectl/issues/1638)

Parkofadown avatar Aug 07 '24 15:08 Parkofadown

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.

k8s-ci-robot avatar Aug 07 '24 15:08 k8s-ci-robot

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 avatar Aug 07 '24 15:08 sftim

/sig cli

sftim avatar Aug 07 '24 15:08 sftim

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 ?

Parkofadown avatar Aug 07 '24 16:08 Parkofadown

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

sftim avatar Aug 07 '24 16:08 sftim

/sig docs /area kubectl documentation

sftim avatar Aug 07 '24 16:08 sftim

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

k8s-ci-robot avatar Aug 07 '24 16:08 k8s-ci-robot

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

sftim avatar Aug 07 '24 16:08 sftim

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

ardaguclu avatar Aug 08 '24 05:08 ardaguclu

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.

Parkofadown avatar Aug 08 '24 10:08 Parkofadown

Also this https://github.com/kubernetes/kubectl/issues/1634

ardaguclu avatar Aug 08 '24 11:08 ardaguclu

/retitle Improve kubectl built-in help

sftim avatar Aug 08 '24 11:08 sftim

and this https://github.com/kubernetes/kubectl/issues/1639

ardaguclu avatar Aug 14 '24 16:08 ardaguclu

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

ah8ad3 avatar Aug 20 '24 08:08 ah8ad3

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

sftim avatar Aug 20 '24 09:08 sftim

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

Parkofadown avatar Aug 20 '24 09:08 Parkofadown

I'd like to work on this umbrella issue by tackling each sub-issue one by one - would that be acceptable?

Antraxmin avatar Apr 28 '25 09:04 Antraxmin