You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Tidy up the release-team experience after the gen-apidocs markdown backend
landed. The Makefile has accumulated drift, gen-kubectldocs is functionally
replaced by gen-compdocs but still present, and several copy targets are
missing. Each of these is small in isolation but coordinated together they
make the per-release workflow significantly cleaner.
Goal
Tidy up the release-team experience after the gen-apidocs markdown backend
landed. The Makefile has accumulated drift, gen-kubectldocs is functionally
replaced by gen-compdocs but still present, and several copy targets are
missing. Each of these is small in isolation but coordinated together they
make the per-release workflow significantly cleaner.
Sub-tasks
Makefile cleanup PR (chore(makefile): scope env-var checks per target, add copyapimd, refresh help #449)
K8S_ROOT/K8S_RELEASE/K8S_WEBROOTchecks into the recipesthat need them (currently fail every
makeinvocation)K8S_ROOTcheckCURDIR=$(shell pwd)line inupdateapispeccopyapimdtarget (symmetric withcopyapi) for the markdownoutput →
content/en/docs/reference/kubernetes-api/alltarget's printed list of supported targetsDeprecate gen-kubectldocs (Adds deprecation note on gen-kubectldocs README and Makefile #450)
#445:
add a deprecation banner to
gen-kubectldocs/README.mdWARNING:echo tocli,copycli,cleanclitargets pointingusers to gen-compdocs
Add
copycompfamily of targets (add copycomp Makefile targets for component docs #452)copycomp-core: kube-apiserver, kube-controller-manager, kube-scheduler,kube-proxy →
content/en/docs/reference/command-line-tools-reference/copycomp-kubeadm: kubeadm tree →content/en/docs/reference/setup-tools/kubeadm/generated/copycomp-kubectl: kubectl tree →content/en/docs/reference/kubectl/generated/Fix cross-group
ByKindcollision PR (fix(gen-apidocs): bucket ByKind by group+kind to avoid cross-group collisions #447)versions" leaks in HTML output)
Switch k/website API reference to apimd output (switch kubernetes-api reference content to gen-apidocs markdown backend kubernetes/website#55758)
content/en/docs/reference/kubernetes-api/(currentlygen-resourcesdocs output, semantic-category folders) with apimd output
(API-group folders)
kubernetes-api/<old-cat>/...URLs to use new
kubernetes-api/<api-group>/...URLsmake copyapimd)Hugo shortcode-based output (#440)
templates control rendering (mobile layout, different render modes, etc.)
To contribute
Comment on this issue showing interest and raise a PR for any unchecked item.