[TineoC]

Part of #57030, per KEP-5295.

make kyaml renders listed manifests into
content/<lang>/examples-kyaml/ with the pinned yamlfmt from sigs.k8s.io/yaml.
make verify-kyaml fails if stale.

Pages to Test

• Pods — Pod
• Deployments — Deployment
• StatefulSet Basics — StatefulSet, two documents in one manifest
• DaemonSet — DaemonSet
• Service — Service
• Configure a Pod to Use a ConfigMap — ConfigMap

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

/sig docs
/language en

[netlify]

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	dbb69f3
🔍 Latest deploy log	https://app.netlify.com/projects/kubernetes-io-main-staging/deploys/6ace41bee070d6621a668686
😎 Deploy Preview	https://deploy-preview-56971--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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

[linux-foundation-easycla]

• ✅ login: TineoC / name: Christopher Tineo (dbb69f3)
• ❌ The email address for the commit (dbb69f3) is not linked to the GitHub account, preventing the EasyCLA check. Consult this Help Article and GitHub Help to resolve. (To view the commit's email address, add .patch at the end of this PR page's URL.) For further assistance with EasyCLA, please visit our EasyCLA portal and chat with our support bot.

One or more co-authors of this pull request were not found. You must specify co-authors in commit message trailer via:

Co-authored-by: name <email>

Supported Co-authored-by: formats include:

1. Anything <id+login@users.noreply.github.com> - it will locate your GitHub user by id part.
2. Anything <login@users.noreply.github.com> - it will locate your GitHub user by login part.
3. Anything <public-email> - it will locate your GitHub user by public-email part. Note that this email must be made public on Github.
4. Anything <other-email> - it will locate your GitHub user by other-email part but only if that email was used before for any other CLA as a main commit author.
5. login <any-valid-email> - it will locate your GitHub user by login part, note that login part must be at least 3 characters long.

Alternatively, if the co-author should not be included, remove the Co-authored-by: line from the commit message.

Please update your commit message(s) by doing git commit --amend and then git push [--force] and then request re-running CLA check via commenting on this pull request:

/easycla

[rxinui]

I would like to involve @soltysh on that PR.

As mentioned on #56915 (comment), this addition could streamline the conversion of every example to KYAML. Probably the challenge would be the maintenance or usage of the script.

[TineoC]

/easycla

[soltysh]

Quickly dropping a few notes from today's SIG-Docs call, where we discussed this topic.

1. We don't want to rush in with this PR, rather we want to focus on having long-term, easy solution to maintain yaml/kyaml and maybe json formats in the listings.
2. From the call there was a suggestion that hugo/docsy supports mechanism for switching listings, which I believe this PR is implementing from scratch. @TineoC it would be good to look into that mechanism and replace that part of your PR with that built-in mechanism instead.
3. The initial PR (this), should focus on the switch mechanism, as well as providing steps how to convert to other formats. The make kyaml is a good example of that.
4. Once we land the initial PR, we'll be able to focus on introducing the remaining files. Whether that'll be a single PR, or a set of PRs is irrelevant.
5. Lastly, we can introduce a checker, to ensure that every listing has all the available formats as a pre-submit job.

[TineoC]

Thanks @soltysh for the comments

[lmktfy]

@TineoC, would you be willing to update this PR so that it's ready to review?

If you'd prefer, you could target the dev-1.38 branch. Your choice (to be confirmed by SIG leadership) whether to land this change as part of 1.38 or via continuous publishing of main.

[TineoC]

https://deploy-preview-56971--kubernetes-io-main-staging.netlify.app/docs/concepts/workloads/pods/

[TineoC]

@TineoC, would you be willing to update this PR so that it's ready to review?

If you'd prefer, you could target the dev-1.38 branch. Your choice (to be confirmed by SIG leadership) is whether to land this change as part of 1.38 or via continuous publishing of main.

I'm sorry for the delay.

I'm open to bringing this up to the next SIG Docs meeting and waiting for leadership to share their thoughts on whether they'd like to move forward with the change.

The preview pages are functional in Desktop and Mobile, so you can review the code and leave your thoughts in the Implementation @lmktfy.

/hold

[kubernetes-prow]

[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 katcosgrove 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:

• OWNERS
• .github/workflows/OWNERS
• content/en/OWNERS
• content/en/community/static/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[TineoC]

Superseded by #58042. This PR was closed by an accidental force-push of a parentless commit and GitHub cannot reopen it.