Skip to content

Add tooling to generate KYAML example variants - #59129

Open
TineoC wants to merge 1 commit into
kubernetes:mainfrom
TineoC:kyaml/tooling
Open

TineoC wants to merge 1 commit into
kubernetes:mainfrom
TineoC:kyaml/tooling

Conversation

@TineoC

@TineoC TineoC commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

Description

Adds make kyaml to generate KYAML copies of example manifests, for code samples that set variants="kyaml". make verify-kyaml fails if they are out of date.

No page opts in yet, so this generates nothing.

Split from #58042, per review:

  1. Show a sample in several formats: Add opt-in serialization variants to code_sample #58042
  2. Generate the KYAML files (this PR)
  3. Use KYAML on pages: follow-up

Question: no CI job runs verify-kyaml today. Add one in test-infra?

Test: Writing a new topic (new section).

Issue

Part of #57030 (KEP-5295). Relates to #58042.

This PR was written in part with the assistance of generative AI.

/sig docs
/language en

Signed-off-by: Christopher Tineo <christophertineo02@gmail.com>
@kubernetes-prow kubernetes-prow Bot added sig/docs Categorizes an issue or PR as relevant to SIG Docs. language/en Issues or PRs related to English language cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Nov 10, 2026
@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 natalisucks 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 the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Nov 10, 2026
@netlify

netlify Bot commented Nov 10, 2026

Copy link
Copy Markdown

✅ Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit d34c868
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-io-main-staging/deploys/6af27d0d4191964d30e55070
😎 Deploy Preview https://deploy-preview-59129--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.

This branch has not been deployed

No deployments
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 sig/docs Categorizes an issue or PR as relevant to SIG Docs. 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.

1 participant