Skip to content

Commit ef70953

Browse files
Fix broken links and move life cycle section
1 parent b67e2cf commit ef70953

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

docs/syntax/applies.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,19 @@ The `applies_to` metadata allows you to specify which product versions, deployme
1010

1111
Taking a mandatory [life-cycle](#life-cycle) with an optional version.
1212

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+
1326
### Version
1427

1528
Can be in either `major.minor` or `major.minor.patch` format
@@ -40,19 +53,6 @@ applies_to:
4053
```
4154
This shows that the feature was introduced in version 9.1 as a preview and became generally available in 9.4.
4255

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-
5656
## When and where to use `applies_to`
5757

5858
✅ 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:
6363

6464
* [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.
6565
* [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.
6767

6868
### Page annotations
6969

docs/syntax/quick-ref.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ The `applies_to` tags are scope signals for readers, not comprehensive metadata.
146146

147147
**DOs**<br>
148148
**Do:** Define a set of [page-level tags](applies.md#page-annotations) in a front matter block<br>
149-
**Do:** Add section-level tags in an `{applies_to}` [directive](applies.md#sections) after a heading<br>
149+
**Do:** Add section-level tags in an `{applies_to}` [directive](applies.md#section-annotations) after a heading<br>
150150
**Do:** Indicate versions (`major.minor` with an optional `[.patch]`) and release phases like `beta`
151151

152152
**DON'Ts**<br>

docs/versions/content-patterns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ deployment:
3939
self: unavailable 9.3.0
4040
```
4141
42-
*see [`applies`](/syntax/applies.md#sections)*
42+
*see [`applies`](/syntax/applies.md#section-annotations)*
4343

4444
**Use case:** Provide signals about a section’s scope so a user can choose to read or skip it as needed
4545

0 commit comments

Comments
 (0)