Skip to content

[Umbrella] Release tooling consolidation: Makefile cleanup, deprecate gen-kubectldocs, add copy targets, switch website to apimd #448

Description

@Caesarsage

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

  1. Makefile cleanup PR (chore(makefile): scope env-var checks per target, add copyapimd, refresh help #449)

    • Move K8S_ROOT / K8S_RELEASE / K8S_WEBROOT checks into the recipes
      that need them (currently fail every make invocation)
    • Drop the duplicate K8S_ROOT check
    • Drop the unused CURDIR=$(shell pwd) line in updateapispec
    • Add copyapimd target (symmetric with copyapi) for the markdown
      output → content/en/docs/reference/kubernetes-api/
    • Refresh the all target's printed list of supported targets
  2. Deprecate gen-kubectldocs (Adds deprecation note on gen-kubectldocs README and Makefile #450)

    • Same pattern as the gen-resourcesdocs deprecation in
      #445:
      add a deprecation banner to gen-kubectldocs/README.md
    • Add a WARNING: echo to cli, copycli, cleancli targets pointing
      users to gen-compdocs
  3. Add copycomp family 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/
    • Mirrors @tengqm's 3-PR component handoff flow.
  4. Fix cross-group ByKind collision PR (fix(gen-apidocs): bucket ByKind by group+kind to avoid cross-group collisions #447)

  5. Switch k/website API reference to apimd output (switch kubernetes-api reference content to gen-apidocs markdown backend kubernetes/website#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 new kubernetes-api/<api-group>/... URLs
    • Depends on item 1 landing first (make copyapimd)
  6. Hugo shortcode-based output (#440)

To contribute

Comment on this issue showing interest and raise a PR for any unchecked item.

Metadata

Metadata

Assignees

Labels

priority/important-longtermImportant over the long term, but may not be staffed and/or may need multiple releases to complete.triage/acceptedIndicates an issue or PR is ready to be actively worked on.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions