Skip to content

Commit 983a929

Browse files
authored
Merge pull request #4174 from camilamacedo86/marker-note
📖 add note to clarify markers in the doc
2 parents 15554b6 + 1dc1912 commit 983a929

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/book/src/reference/markers/crd-validation.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,16 @@ schema option.
66

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

9+
<aside class="note">
10+
<h1>Understanding Marker Grouping in Documentation</h1>
11+
12+
Certain markers may seem duplicated. However, these markers are grouped based on their context of use
13+
— such as fields, types, or arrays. For instance, a marker like `+kubebuilder:validation:Enum` can be applied to
14+
individual fields or array items, and this flexibility is reflected in the documentation.
15+
16+
The grouping ensures clarity by showing how the same marker can be reused for different purposes.
17+
18+
</aside>
19+
20+
921
{{#markerdocs CRD validation}}

0 commit comments

Comments
 (0)