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

Improve reference generator for kubectl #349

Closed tengqm closed 3 months ago

tengqm commented 6 months ago

Improve component reference generator for kubectl so that the references are generated into sub-directories. This change has no impact on other components like kube-apiserver, kube-controller-manager. It make impact how kubeadm reference are generated.

sftim commented 6 months ago

/sig docs /approve

k8s-ci-robot commented 6 months ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim, tengqm

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/kubernetes-sigs/reference-docs/blob/master/OWNERS)~~ [sftim,tengqm] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
sftim commented 6 months ago

It make impact how kubeadm reference are generated.

Can you explain more about that @tengqm ? If there might be an impact, it'll help to know what to look for (as a reviewer).

tengqm commented 6 months ago

It make impact how kubeadm reference are generated.

Can you explain more about that @tengqm ? If there might be an impact, it'll help to know what to look for (as a reviewer).

The logic introduced will have an impact on all kube components that have sub-commands. This is in general not an issue for kube-apiserver or kube-proxy etc. But for kubeadm, there are sub commands. The generated files will be nested into subdirectories as well. Need to investigate.

eddiezane commented 4 months ago

/assign

sftim commented 3 months ago

The logic introduced will have an impact on all kube components that have sub-commands. This is in general not an issue for kube-apiserver or kube-proxy etc. But for kubeadm, there are sub commands. The generated files will be nested into subdirectories as well. Need to investigate.

Maybe we'll want redirects if we do change the URLs vs. existing kubeadm docs. If we do, adding those is a one-off task.