kubectl icon indicating copy to clipboard operation
kubectl copied to clipboard

Improvement needed for kubectl plugin help

Open Ritikaa96 opened this issue 1 year ago • 6 comments

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 avatar Feb 09 '24 07:02 Ritikaa96

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 avatar Feb 09 '24 07:02 k8s-ci-robot

/sig cli

Ritikaa96 avatar Feb 09 '24 07:02 Ritikaa96

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

Ritikaa96 avatar Feb 09 '24 07:02 Ritikaa96

Related to #https://github.com/kubernetes/kubectl/issues/1432 I would like to work on this issue , once the traige is accepted.

Ritikaa96 avatar Feb 09 '24 07:02 Ritikaa96

/triage accepted

mpuckett159 avatar Mar 27 '24 22:03 mpuckett159

Raised a PR here

Ritikaa96 avatar Apr 08 '24 11:04 Ritikaa96