Skip to content

Commit

Permalink
Merge pull request kubernetes-sigs#4174 from camilamacedo86/marker-note
Browse files Browse the repository at this point in the history
📖 add note to clarify markers in the doc
  • Loading branch information
k8s-ci-robot authored Sep 21, 2024
2 parents 15554b6 + 1dc1912 commit 983a929
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/book/src/reference/markers/crd-validation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,16 @@ schema option.

See [Generating CRDs](/reference/generating-crd.md) for examples.

<aside class="note">
<h1>Understanding Marker Grouping in Documentation</h1>

Certain markers may seem duplicated. However, these markers are grouped based on their context of use
— such as fields, types, or arrays. For instance, a marker like `+kubebuilder:validation:Enum` can be applied to
individual fields or array items, and this flexibility is reflected in the documentation.

The grouping ensures clarity by showing how the same marker can be reused for different purposes.

</aside>


{{#markerdocs CRD validation}}

0 comments on commit 983a929

Please sign in to comment.