search

kubernetes-sigs / reference-docs

Tools to build reference documentation for Kubernetes APIs and CLIs.
Apache License 2.0
87 stars 102 forks source link

Kubectl generated docs page contains deprecated flags #344

Closed mpuckett159 closed 3 months ago

mpuckett159 commented 8 months ago

It looks like something has broken for the kubectl docs generation scripting. There is currently at least one flag (I need to investigate further to determine if there are more) for the run subcommand that has been deprecated since 1.24, and is no longer listed in the kubectl help text, or in the kubectl source code. The page can be found here. I can help out if someone points me to what is generating this page. I also see the yaml here listing it, too.

tengqm commented 8 months ago

Actually, I'm more inclined to drop the old way to generate the kubectl reference which is based on a docker image that was not maintained. We could instead generate kubectl reference using the gen-comp command. The output is pure markdown, so it is more in line with the whole k8s website. I did that and proposed a PR to k8s website. The PR wasn't approved yet. Maybe you can help review it and see if there are things to do there.

mpuckett159 commented 8 months ago

I'll reach out to Brian to discuss since I've worked with him on some kubectl things. I think he would probably be fine with this, just may not be aware. Thank you for pointing me to this.

brianpursley commented 8 months ago

I left a comment on the PR related to this issue. https://github.com/kubernetes/website/pull/42664#issuecomment-1830637341

k8s-triage-robot commented 5 months ago

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

You can:

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot commented 4 months ago

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

You can:

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

k8s-triage-robot commented 3 months ago

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues according to the following rules:

You can:

Please send feedback to sig-contributor-experience at kubernetes/community.

/close not-planned

k8s-ci-robot commented 3 months ago

@k8s-triage-robot: Closing this issue, marking it as "Not Planned".

In response to [this](https://github.com/kubernetes-sigs/reference-docs/issues/344#issuecomment-2080191491): >The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs. > >This bot triages issues according to the following rules: >- After 90d of inactivity, `lifecycle/stale` is applied >- After 30d of inactivity since `lifecycle/stale` was applied, `lifecycle/rotten` is applied >- After 30d of inactivity since `lifecycle/rotten` was applied, the issue is closed > >You can: >- Reopen this issue with `/reopen` >- Mark this issue as fresh with `/remove-lifecycle rotten` >- Offer to help out with [Issue Triage][1] > >Please send feedback to sig-contributor-experience at [kubernetes/community](https://github.com/kubernetes/community). > >/close not-planned > >[1]: https://www.kubernetes.dev/docs/guide/issue-triage/ 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/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.