Skip to content

Enhance help text for the 'top' command #132567

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
Merged
merged 1 commit into from
Jun 30, 2025
Merged

Enhance help text for the 'top' command #132567

merged 1 commit into from
Jun 30, 2025
+24 −2

Conversation

janetkuo
Copy link
Member

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

The kubectl top command's help text was factually correct but lacked the necessary context for users to use it effectively.

Which issue(s) this PR is related to:

kubernetes/kubectl#830

Does this PR introduce a user-facing change?

NONE

@serathius

@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. 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 27, 2025
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

If a SIG or subproject determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

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 k8s-ci-robot added needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Jun 27, 2025
@k8s-ci-robot k8s-ci-robot added area/kubectl sig/cli Categorizes an issue or PR as relevant to SIG CLI. labels Jun 27, 2025
@github-project-automation github-project-automation bot moved this to Needs Triage in SIG CLI Jun 27, 2025
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. label Jun 27, 2025
@janetkuo
Copy link
Member Author

/sig instrumentation

@k8s-ci-robot k8s-ci-robot added the sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation. label Jun 27, 2025
serathius
serathius reviewed Jun 27, 2025
View reviewed changes
serathius
serathius reviewed Jun 27, 2025
View reviewed changes
serathius
serathius reviewed Jun 27, 2025
View reviewed changes
serathius
serathius reviewed Jun 27, 2025
View reviewed changes
@serathius
Copy link
Contributor

Overall lgtm, couple of nits as since posting the issue we had made multiple improvements to metrics-server documentation.

@janetkuo
Enhance help text for the 'top' command
e54e01e 
* Detailing the metrics source
* Connecting to HPA
* Defining its scope
@janetkuo
Copy link
Member Author

Thanks @serathius for the review! PTAL

@serathius
Copy link
Contributor

Looks great, thank you!
/lgtm

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

LGTM label has been added.

Git tree hash: 687d38e2015758c74470fa02f517954664d38d0e

@ardaguclu
Copy link
Member

We occasionally get issues about the misunderstanding of top command. This PR will have a positive impact by elaborating the behavior. Thank you
/approve
/hold
in case you want more review from instrumentation

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 30, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ardaguclu, janetkuo

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

The pull request process is described 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 the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 30, 2025
@janetkuo
Copy link
Member Author

SIG instrumentation has reviewed and lgtm'd, so this should be good to go
/unhold

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 30, 2025
@k8s-ci-robot k8s-ci-robot merged commit c1e421a into kubernetes:master Jun 30, 2025
13 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v1.34 milestone Jun 30, 2025
@github-project-automation github-project-automation bot moved this from Needs Triage to Done in SIG CLI Jun 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@serathius serathius serathius left review comments

@ardaguclu ardaguclu Awaiting requested review from ardaguclu

@brianpursley brianpursley Awaiting requested review from brianpursley

Assignees

@serathius serathius

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/kubectl 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. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. release-note-none Denotes a PR that doesn't merit a release note. sig/cli Categorizes an issue or PR as relevant to SIG CLI. sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
SIG CLI
Status: Done
Milestone
v1.34
Development

Successfully merging this pull request may close these issues.
4 participants
@janetkuo @k8s-ci-robot @serathius @ardaguclu