You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/syntax/applies.md
+37-18Lines changed: 37 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,31 +29,26 @@ Where:
29
29
- The lifecycle is mandatory.
30
30
- The version is optional.
31
31
32
-
:::{important}
33
-
All documentation pages must include an `applies_to` tag in the YAML frontmatter. Use YAML frontmatter to indicate each deployment target's availability and lifecycle status. For a complete list of supported keys and values, see the [frontmatter syntax guide](./frontmatter.md).
34
-
:::
32
+
### Page level
35
33
36
-
### Versioned products
34
+
Page level annotations are added in the YAML frontmatter, starting with the `applies_to` key and following the [key-value reference](#key-value-reference). For example:
37
35
38
-
Versioned products require a `version` tag to be used with the `lifecycle` tag:
39
-
40
-
```
36
+
```yaml
37
+
---
41
38
applies_to:
42
-
stack: preview 9.1, ga 9.4
39
+
stack: ga
43
40
deployment:
44
-
ece: deprecated 9.2, removed 9.8
41
+
ece: ga
42
+
---
45
43
```
46
44
47
-
Unversioned products use `lifecycle` tags without a version:
45
+
For more examples, refer to [Page annotation examples](#page-annotation-examples).
48
46
49
-
```
50
-
applies_to:
51
-
serverless:
52
-
elasticsearch: beta
53
-
observability: removed
54
-
```
47
+
:::{important}
48
+
All documentation pages must include an `applies_to` tag in the YAML frontmatter.
49
+
:::
55
50
56
-
### Section annotations
51
+
### Section level
57
52
58
53
A header can be followed by an `{applies_to}` directive which contextualizes the applicability of the section further.
59
54
@@ -75,11 +70,13 @@ stack: ga 9.1
75
70
76
71
This allows the YAML inside the `{applies_to}` directive to be fully highlighted.
77
72
73
+
For more examples, refer to [Section annotation examples](#section-annotation-examples).
74
+
78
75
:::{note}
79
76
The `{applies_to}` directive must be preceded by a heading directly.
80
77
:::
81
78
82
-
### Inline annotations
79
+
### Inline level
83
80
84
81
You can add inline applies annotations to any line using the following syntax:
85
82
@@ -95,6 +92,8 @@ Property {preview}`<version>`
95
92
: definition body
96
93
```
97
94
95
+
For more examples, refer to [Inline annotation examples](#inline-annotation-examples).
96
+
98
97
## Key-value reference
99
98
100
99
Use the following key-value reference to find the appropriate key and value for your applicability statements.
@@ -125,6 +124,26 @@ Use the following key-value reference to find the appropriate key and value for
125
124
126
125
## Examples
127
126
127
+
### Versioning examples
128
+
129
+
Versioned products require a `version` tag to be used with the `lifecycle` tag:
130
+
131
+
```
132
+
applies_to:
133
+
stack: preview 9.1, ga 9.4
134
+
deployment:
135
+
ece: deprecated 9.2, removed 9.8
136
+
```
137
+
138
+
Unversioned products use `lifecycle` tags without a version:
0 commit comments