kubernetes-sigs / kubernetes-sigs/reference-docs
[Umbrella] Release tooling consolidation: Makefile cleanup, deprecate gen-kubectldocs, add copy targets, switch website to apimd
@Caesarsage is already working on this.
Since Jul 4, 2026.
- Dominant language
- HTML
- Stars
- 130
- Forks
- 135
- Avg merge
- 16h 27m
- Merged PRs (30d)
- 3
Description
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 (https://github.com/kubernetes-sigs/reference-docs/pull/449)
- Move
K8S_ROOT/K8S_RELEASE/K8S_WEBROOTchecks into the recipes
that need them (currently fail everymakeinvocation) - Drop the duplicate
K8S_ROOTcheck - Drop the unused
CURDIR=$(shell pwd)line inupdateapispec - Add
copyapimdtarget (symmetric withcopyapi) for the markdown
output →content/en/docs/reference/kubernetes-api/ - Refresh the
alltarget's printed list of supported targets
- Move
-
Deprecate gen-kubectldocs (https://github.com/kubernetes-sigs/reference-docs/pull/450)
- Same pattern as the gen-resourcesdocs deprecation in
#445:
add a deprecation banner togen-kubectldocs/README.md - Add a
WARNING:echo tocli,copycli,cleanclitargets pointing
users to gen-compdocs
- Same pattern as the gen-resourcesdocs deprecation in
-
Add
copycompfamily of targets (https://github.com/kubernetes-sigs/reference-docs/pull/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/- Mirrors @tengqm's 3-PR component handoff flow.
-
Fix cross-group
ByKindcollision PR (https://github.com/kubernetes-sigs/reference-docs/pull/447)- Tracked at #446 with concrete v1.36 evidence (cross-group "Other API
versions" leaks in HTML output) - Independent of other items; can ship in this same release cycle
- Tracked at #446 with concrete v1.36 evidence (cross-group "Other API
-
Switch k/website API reference to apimd output (https://github.com/kubernetes/website/pull/55758)
- Replace
content/en/docs/reference/kubernetes-api/(currently
gen-resourcesdocs output, semantic-category folders) with apimd output
(API-group folders) - Update ~79 hand-curated docs that link to old
kubernetes-api/<old-cat>/...
URLs to use newkubernetes-api/<api-group>/...URLs - Depends on item 1 landing first (
make copyapimd)
- Replace
-
Hugo shortcode-based output (#440)
- Goal: emit shortcode-wrapped fields instead of HTML tables so k/website
templates control rendering (mobile layout, different render modes, etc.) - Tracked separately at #440; blocked on @lmktfy's markdown sketch
- Sequenced after items 1, 3, 5 land
- Goal: emit shortcode-wrapped fields instead of HTML tables so k/website
To contribute
Comment on this issue showing interest and raise a PR for any unchecked item.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.