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

Improvement needed for kubectl plugin help #1554

Open
Ritikaa96 opened this issue Feb 9, 2024 · 6 comments
Open

Improvement needed for kubectl plugin help #1554

Ritikaa96 opened this issue Feb 9, 2024 · 6 comments
Assignees
Labels
kind/feature Categorizes issue or PR as related to a new feature. sig/cli Categorizes an issue or PR as relevant to SIG CLI. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@Ritikaa96
Copy link
Contributor

Ritikaa96 commented Feb 9, 2024

What would you like to be added?

  • improvment in the content of description as:
    The output for kubectl plugin shows double text -
$ kubectl plugin
Provides utilities for interacting with plugins.

 Plugins provide extended functionality that is not part of the major
command-line distribution. Please refer to the documentation and examples for
more information about how write your own plugins.

 The easiest way to discover and install plugins is via the kubernetes
sub-project krew. To install krew, visit
https://krew.sigs.k8s.io/docs/user-guide/setup/install/ krew.sigs.k8s.io
https://krew.sigs.k8s.io/docs/user-guide/setup/install/

Available Commands:
  list          List all visible plugin executables on a user's PATH

Usage:
  kubectl plugin [flags] [options]

Use "kubectl plugin <command> --help" for more information about a given
command.
Use "kubectl options" for a list of global command-line options (applies to all
commands).

the link to Krew is showing twice.

  • Also can we add Example to this help page?
  • name-only is not mentioned in this help page but it exist in here

Why is this needed?

The Kubectl plugin help page has double text in description
And there is no example , no mention of name-only.

@Ritikaa96 Ritikaa96 added the kind/feature Categorizes issue or PR as related to a new feature. label Feb 9, 2024
@k8s-ci-robot k8s-ci-robot added the needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. label Feb 9, 2024
@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/test-infra repository.

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

/sig cli

@k8s-ci-robot k8s-ci-robot added sig/cli Categorizes an issue or PR as relevant to SIG CLI. and removed needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Feb 9, 2024
@Ritikaa96
Copy link
Contributor Author

as this is related to cli , transferring it to the same.
/transfer kubectl

@k8s-ci-robot k8s-ci-robot transferred this issue from kubernetes/kubernetes Feb 9, 2024
@Ritikaa96
Copy link
Contributor Author

Related to ##1432
I would like to work on this issue , once the traige is accepted.

@mpuckett159
Copy link
Contributor

/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 Mar 27, 2024
@Ritikaa96
Copy link
Contributor Author

Raised a PR here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature. sig/cli Categorizes an issue or PR as relevant to SIG CLI. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
Status: Needs Triage
Development

No branches or pull requests

3 participants