Skip to content

📖 docs: Add examples to all marker types.#1340

Open
camilamacedo86 wants to merge 1 commit intokubernetes-sigs:mainfrom
camilamacedo86:improve-docs
Open

📖 docs: Add examples to all marker types.#1340
camilamacedo86 wants to merge 1 commit intokubernetes-sigs:mainfrom
camilamacedo86:improve-docs

Conversation

@camilamacedo86
Copy link
Member

@camilamacedo86 camilamacedo86 commented Feb 15, 2026

Add comprehensive usage examples and improved field documentation to all marker types (validation, CRD, webhook, RBAC, topology).

Generated-by: Cursor/Claude

Closes: #1054

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: camilamacedo86
Once this PR has been reviewed and has the lgtm label, please assign joelanford 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

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Feb 15, 2026
@camilamacedo86
Copy link
Member Author

/test pull-controller-tools-test-main

@camilamacedo86 camilamacedo86 changed the title 📖 docs: add examples to marker documentation for programmatic generation 📖 docs: Add examples to all marker types. Fix XValidation to use correct CEL variables (self/oldSelf). Feb 15, 2026
Add comprehensive usage examples and improved field documentation to all
marker types (validation, CRD, webhook, RBAC, topology).
Generated-by: Cursor/Claude
@camilamacedo86 camilamacedo86 changed the title 📖 docs: Add examples to all marker types. Fix XValidation to use correct CEL variables (self/oldSelf). 📖 docs: Add examples to all marker types. Feb 15, 2026
@camilamacedo86
Copy link
Member Author

Hi @JoelSpeed @sbueringer,

Kubebuilder generates the marker documentation automatically, but for a long time we’ve wanted to ensure we provide valid examples for all markers.

To address that, I used an AI to help draft example snippets and validate the existing docs/changes. I then manually reviewed everything that was generated/updated and didn’t spot any issues.

Could you give a hand on this to review?
Thanks! 🙌

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. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Example Usage in Marker Code Documentation for Programmatic Docs Generation

2 participants