Skip to content

Improve the Kubernetes API reference generation guide#56398

Open
Caesarsage wants to merge 1 commit into
kubernetes:mainfrom
Caesarsage:docs/modernize-kubernetes-api-refdoc
Open

Improve the Kubernetes API reference generation guide#56398
Caesarsage wants to merge 1 commit into
kubernetes:mainfrom
Caesarsage:docs/modernize-kubernetes-api-refdoc

Conversation

@Caesarsage

Copy link
Copy Markdown
Contributor

Updates kubernetes-api.md to the current gen-apidocs flow:

Drops GOPATH-era setup (go get, GOPATH) and the required kubernetes/kubernetes clone — the API flow is now checkout-free.

  • make updateapispec → make updateapispec-enums-from-source, so the generated reference no longer silently ships without enum values.
  • Documents both backends (copyapi HTML, copyapimd Markdown) and --auto-detect (no per-release config.yaml).
  • Removes the stale note attributing the Markdown reference to the now-deprecated gen-resourcesdocs.

Part of #56385 .

@kubernetes-prow

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign kernel-kun for approval. For more information see the Code Review Process.

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

Details 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

@kubernetes-prow kubernetes-prow Bot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 6, 2026
@netlify

netlify Bot commented Jul 6, 2026

Copy link
Copy Markdown

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit c052835
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-io-main-staging/deploys/6a4cb82b86eda1000821d61e
😎 Deploy Preview https://deploy-preview-56398--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@Caesarsage

Copy link
Copy Markdown
Contributor Author

@lmktfy lmktfy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

I hope these suggestions are helpful.

Comment thread content/en/docs/contribute/generate-ref-docs/kubernetes-api.md Outdated
Comment thread content/en/docs/contribute/generate-ref-docs/kubernetes-api.md Outdated
Comment thread content/en/docs/contribute/generate-ref-docs/kubernetes-api.md Outdated
Comment thread content/en/docs/contribute/generate-ref-docs/kubernetes-api.md Outdated
Comment thread content/en/docs/contribute/generate-ref-docs/kubernetes-api.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants