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
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,19 @@ The `applies_to` metadata allows you to specify which product versions, deployme
10
10
11
11
Taking a mandatory [life-cycle](#life-cycle) with an optional version.
12
12
13
+
### Life cycle
14
+
15
+
`applies_to` accepts the following lifecycle states:
16
+
17
+
*`preview`
18
+
*`beta`
19
+
*`deprecated`
20
+
*`removed`
21
+
*`unavailable`
22
+
*`ga`
23
+
24
+
Both versioned and unversioned products use the same lifecycle tags, but only versioned products can be marked `ga`. Unversioned products are considered `ga` by default and don’t need specification.
25
+
13
26
### Version
14
27
15
28
Can be in either `major.minor` or `major.minor.patch` format
@@ -40,19 +53,6 @@ applies_to:
40
53
```
41
54
This shows that the feature was introduced in version 9.1 as a preview and became generally available in 9.4.
42
55
43
-
### Life cycle
44
-
45
-
`applies_to` accepts the following lifecycle states:
46
-
47
-
*`preview`
48
-
*`beta`
49
-
*`deprecated`
50
-
*`removed`
51
-
*`unavailable`
52
-
*`ga`
53
-
54
-
Both versioned and unversioned products use the same lifecycle tags, but only versioned products can be marked `ga`. Unversioned products are considered `ga` by default and don’t need specification.
55
-
56
56
## When and where to use `applies_to`
57
57
58
58
✅ Use `applies_to` tags when features change state (`introduced`, `deprecated`, `removed`) or when availability differs across deployments and environments.
@@ -63,7 +63,7 @@ The `applies_to` metadata can be added at different levels in the documentation:
63
63
64
64
*[Page-level](#page-annotations) metadata is **mandatory** and must be included in the frontmatter. This defines the overall applicability of the page across products, deployments, and environments.
65
65
*[Section-level](#section-annotations) annotations allow you to specify different applicability for individual sections when only part of a page varies between products or versions.
66
-
*[Inline](#inline-applies-to) annotations allow fine-grained annotations within paragraphs or definition lists. This is useful for highlighting the applicability of specific phrases, sentences, or properties without disrupting the surrounding content.
66
+
*[Inline](#inline-annotations) annotations allow fine-grained annotations within paragraphs or definition lists. This is useful for highlighting the applicability of specific phrases, sentences, or properties without disrupting the surrounding content.
0 commit comments