search

kubernetes / website

Kubernetes website and documentation repo:
https://kubernetes.io
Creative Commons Attribution 4.0 International
4.51k stars 14.46k forks source link

Issue with k8s.io/docs/reference/kubectl/generated/kubectl_config/kubectl_config_use-context/ #48255

Open princeking opened 1 month ago

princeking commented 1 month ago

The documentation is very confusing, there is not enough examples after commands for example:

--kubeconfig string

  | use a particular kubeconfig file

it doesn't give you an example of how to use it and would have been better to give an example as follows:

kubectl config use-context research --kubeconfig /user/my-new-kube-config

k8s-ci-robot commented 1 month ago

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](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.
utkarsh-singh1 commented 1 month ago

@princeking, this page is automatically generated, fix will be somewhere around kubernetes/kubernetes repo.

utkarsh-singh1 commented 1 month ago

Also, I don't think this page require any update as this is just reference section, examples can be set at tasks or tutorial section.

sftim commented 1 month ago

/language en

/sig cli To fix this, make a change to [the source code of] kubectl itself.