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.

Sign up for GitHub

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

Jump to bottom

cmd: add missing short descriptions to kube commands #125486

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

cmd: add missing short descriptions to kube commands #125486

wants to merge 1 commit into from

Conversation

mauri870
Copy link
Member

What type of PR is this?

/kind cleanup
/kind feature

What this PR does / why we need it:

This PR adds short descriptions for the kubernetes command line tools.

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

None

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/feature Categorizes issue or PR as related to a new feature. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Jun 13, 2024
@mauri870 mauri870 changed the title cmd: added missing short descriptions to kube commands cmd: add missing short descriptions to kube commands Jun 13, 2024
@k8s-ci-robot k8s-ci-robot added needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Jun 13, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @mauri870. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@mauri870 mauri870 force-pushed the feature/short-description-commands branch from 364df36 to 9181c51 Compare June 13, 2024 12:11
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: mauri870
Once this PR has been reviewed and has the lgtm label, please assign aojea, derekwaynecarr, jpbetz, sanposhiho for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added area/apiserver area/kube-proxy area/kubelet sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. sig/network Categorizes an issue or PR as relevant to SIG Network. sig/node Categorizes an issue or PR as relevant to SIG Node. sig/scheduling Categorizes an issue or PR as relevant to SIG Scheduling. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Jun 13, 2024
@fedebongio
Copy link
Contributor

/assign @seans3
/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 Jun 13, 2024
@mauri870 mauri870 force-pushed the feature/short-description-commands branch from 9181c51 to 0025128 Compare June 14, 2024 11:09
@bart0sh
Copy link
Contributor

bart0sh commented Jun 26, 2024

/ok-to-test
/triage accepted

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jun 26, 2024
@mauri870 mauri870 force-pushed the feature/short-description-commands branch from 0025128 to 52c9dc4 Compare June 26, 2024 12:11
@mauri870 mauri870 force-pushed the feature/short-description-commands branch from 52c9dc4 to 5fb288a Compare July 20, 2024 17:37
@k8s-ci-robot k8s-ci-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. do-not-merge/contains-merge-commits Indicates a PR which contains merge commits. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Jul 26, 2024
@mauri870 mauri870 force-pushed the feature/short-description-commands branch from d7c8a39 to e20b437 Compare July 27, 2024 10:04
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/contains-merge-commits Indicates a PR which contains merge commits. label Jul 27, 2024
@mauri870
Copy link
Member Author

mauri870 commented Aug 1, 2024

Kindly requesting approvals, thanks.

@adrianmoisey adrianmoisey mentioned this pull request Sep 6, 2024
Closed
11 tasks
@bart0sh
Copy link
Contributor

bart0sh commented Sep 19, 2024

/priority backlog

@k8s-ci-robot k8s-ci-robot added priority/backlog Higher priority than priority/awaiting-more-evidence. and removed needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Sep 19, 2024
@bart0sh
Copy link
Contributor

bart0sh commented Sep 19, 2024

/lgtm
from SIG-Node perspective

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 19, 2024
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 8698fad1403278e8bc117791110a0a1d9fc90235

@pacoxu
Copy link
Member

pacoxu commented Oct 17, 2024

short is only shown for its sub-commands IIUC.

kubernetes/staging/src/k8s.io/kubectl/pkg/cmd/annotate/annotate.go

Line 155 in 0ac74ed

Short: i18n.T("Update the annotations on a resource"), 

[root@paco ~]# kubectl (auto completion)

annotate       (Update the annotations on a resource)

kubernetes/staging/src/k8s.io/kubectl/pkg/cmd/create/create.go

Line 108 in 0ac74ed

Short: i18n.T("Create a resource from a file or from stdin"), 

[root@paco ~]# kubectl --help
kubectl controls the Kubernetes cluster manager.

 Find more information at: https://kubernetes.io/docs/reference/kubectl/

Basic Commands (Beginner):
  create          Create a resource from a file or from stdin

@pacoxu
Copy link
Member

pacoxu commented Oct 17, 2024

Take kubelet as an example, kubelet --help will show the Long.

Could you check if there is another scenario that the short will be shown for a command like kubelet which does not have a sub command?

@mauri870
Copy link
Member Author

Could you check if there is another scenario that the short will be shown for a command like kubelet which does not have a sub command?

Sorry for the delay, I think the short description is only shown in the help page for subcommands. This change is mainly for consistency, as these commands are the only ones without a short description. The way the commands are layed out today, I don't think this is displayed anywhere, but I could be wrong.

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 22, 2024
@k8s-ci-robot
Copy link
Contributor

PR needs rebase.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adrianmoisey adrianmoisey adrianmoisey left review comments

@andrewsykim andrewsykim Awaiting requested review from andrewsykim

@deads2k deads2k Awaiting requested review from deads2k

Assignees

@seans3 seans3

@bart0sh bart0sh

Labels
area/apiserver area/kube-proxy area/kubelet cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. kind/feature Categorizes issue or PR as related to a new feature. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. priority/backlog Higher priority than priority/awaiting-more-evidence. release-note-none Denotes a PR that doesn't merit a release note. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. sig/network Categorizes an issue or PR as relevant to SIG Network. sig/node Categorizes an issue or PR as relevant to SIG Node. sig/scheduling Categorizes an issue or PR as relevant to SIG Scheduling. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
SIG Node: code and documentation PRs
Status: not-only-sig-node
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@mauri870 @k8s-ci-robot @fedebongio @bart0sh @pacoxu @adrianmoisey @seans3