reference-docs icon indicating copy to clipboard operation
reference-docs copied to clipboard

Improve reference generator for kubectl

Open tengqm opened this issue 1 year ago • 6 comments

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.

tengqm avatar Jan 06 '24 06:01 tengqm

/sig docs /approve

sftim avatar Jan 06 '24 11:01 sftim

[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:

Approvers can indicate their approval by writing /approve in a comment Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot avatar Jan 06 '24 11:01 k8s-ci-robot

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).

sftim avatar Jan 06 '24 11:01 sftim

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.

tengqm avatar Jan 06 '24 14:01 tengqm

/assign

eddiezane avatar Mar 19 '24 11:03 eddiezane

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.

sftim avatar Apr 04 '24 17:04 sftim