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

Unclear built-in help for kubectl set #1639

Closed
Parkofadown opened this issue Aug 7, 2024 · 13 comments
Closed

Unclear built-in help for kubectl set #1639

Parkofadown opened this issue Aug 7, 2024 · 13 comments
Labels
needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. sig/cli Categorizes an issue or PR as relevant to SIG CLI. sig/docs Categorizes an issue or PR as relevant to SIG Docs.

Comments

@Parkofadown
Copy link

Page is automatically generated
As of 3:52 PM on 8/7/24
Synopsis states: Configure application resources. These commands help you make changes to existing application resources.

Recommend clarifying what application resources you can configure. Second sentence should be worded as: This command helps you make changes to existing application resources.
Recommend adding an example usage field

Thanks,
PARKOFADOWN

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

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.

@steve-hardman
Copy link

Related page for issue: https://kubernetes.io/docs/reference/kubectl/generated/kubectl_set/

/language en

@utkarsh-singh1
Copy link

@Parkofadown, please follow the templated either you are filling issue for bug or feature.

@utkarsh-singh1
Copy link

Currrent description is filed is bit hard to understand.

@utkarsh-singh1
Copy link

@Parkofadown, Can you clarify what changes you want to make changes to this docs.

Related page for issue: https://kubernetes.io/docs/reference/kubectl/generated/kubectl_set/

@utkarsh-singh1
Copy link

/triage needs-information

@k8s-ci-robot k8s-ci-robot added the triage/needs-information Indicates an issue needs more information in order to work on it. label Aug 8, 2024
@Parkofadown
Copy link
Author

Parkofadown commented Aug 8, 2024

@Parkofadown, Can you clarify what changes you want to make changes to this docs.

Related page for issue: https://kubernetes.io/docs/reference/kubectl/generated/kubectl_set/

@utkarsh-singh1 You need to state what application resources are being changed. Re-read what I wrote in the original description. Also there is no example how to use this command

@sftim
Copy link
Contributor

sftim commented Aug 8, 2024

/transfer kubectl

@k8s-ci-robot k8s-ci-robot transferred this issue from kubernetes/website Aug 8, 2024
@sftim
Copy link
Contributor

sftim commented Aug 8, 2024

/retitle Unclear built-in help for kubectl set

@k8s-ci-robot k8s-ci-robot changed the title Improvement for k8s.io/docs/reference/kubectl/generated/kubectl_set/ Unclear built-in help for kubectl set Aug 8, 2024
@sftim
Copy link
Contributor

sftim commented Aug 8, 2024

/sig cli docs

@k8s-ci-robot k8s-ci-robot added sig/cli Categorizes an issue or PR as relevant to SIG CLI. sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Aug 8, 2024
@ah8ad3
Copy link
Member

ah8ad3 commented Aug 8, 2024

I think we talked about these documents few months ago in the SIG, i can't recall what was the decision. The team will see and triage it.

The doc on the command itself is more clear try: kubectl set -h @Parkofadown

@ardaguclu ardaguclu removed the triage/needs-information Indicates an issue needs more information in order to work on it. label Aug 14, 2024
@ardaguclu
Copy link
Member

/close

@k8s-ci-robot
Copy link
Contributor

@ardaguclu: Closing this issue.

In response to this:

/close

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
Labels
needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. sig/cli Categorizes an issue or PR as relevant to SIG CLI. sig/docs Categorizes an issue or PR as relevant to SIG Docs.
Projects
None yet
Development

No branches or pull requests

7 participants