Skip to content

Commit 810358d

Browse files
leemthompoleemthompo
committed
Sync with latest docs-builder changes
Updates syntax documentation to match latest docs-builder: - Adds applies-to-admonitions.md snippet for admonitions with applies_to - Adds applies-to-dropdowns.md snippet for dropdowns with applies_to badges - Refactors admonitions.md and dropdowns.md to use new snippet includes These changes align with upstream docs-builder updates made on Nov 3, 2025.
1 parent ffd7d17 commit 810358d

File tree

4 files changed

+84
-84
lines changed

4 files changed

+84
-84
lines changed

‎contribute-docs/syntax/_snippets/applies-to-admonitions.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
Admonitions support the `applies_to` property to indicate which products or versions the information applies to.
2+
3+
:::::{tab-set}
4+
5+
::::{tab-item} Output
6+
7+
:::{note}
8+
:applies_to: stack: ga 9.1.0
9+
10+
This note applies to the Elastic Stack GA version 9.1.0.
11+
:::
12+
13+
:::{warning}
14+
:applies_to: serverless: ga
15+
16+
This warning applies to serverless GA.
17+
:::
18+
19+
:::{tip}
20+
:applies_to: { ess:, ece: }
21+
22+
This tip applies to ECH and ECE.
23+
:::
24+
25+
:::{important}
26+
:applies_to: {"stack": "ga 9.2, preview 9.1", "serverless": "ga"}
27+
28+
This important note applies to Elastic Stack GA version 9.2 and Elastic Stack Preview version 9.1. It also applies to serverless GA.
29+
:::
30+
31+
::::
32+
33+
::::{tab-item} Markdown
34+
35+
```markdown
36+
:::{note}
37+
:applies_to: stack: ga 9.1.0
38+
39+
This note applies to the Elastic Stack GA version 9.1.0.
40+
:::
41+
42+
:::{warning}
43+
:applies_to: serverless: ga
44+
45+
This warning applies to serverless GA.
46+
:::
47+
48+
:::{tip}
49+
:applies_to: { ess:, ece: }
50+
51+
This tip applies to ECH and ECE.
52+
:::
53+
54+
:::{important}
55+
:applies_to: {"stack": "ga 9.2, preview 9.1", "serverless": "ga"}
56+
57+
This important note applies to Elastic Stack GA version 9.2 and Elastic Stack Preview version 9.1. It also applies to serverless GA.
58+
:::
59+
```
60+
61+
::::
62+
63+
:::::

‎contribute-docs/syntax/_snippets/applies-to-dropdowns.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
You can add an applies_to badge to the dropdown title by specifying the `:applies_to:` option. This displays a badge indicating which deployment types, versions, or other applicability criteria the dropdown content applies to.
2+
3+
**Source**
4+
5+
```markdown
6+
:::{dropdown} Dropdown Title
7+
:applies_to: stack: ga 9.0
8+
Dropdown content for Stack GA 9.0
9+
:::
10+
```
11+
12+
**Rendering**
13+
14+
:::{dropdown} Dropdown Title
15+
:applies_to: stack: ga 9.0
16+
Dropdown content for Stack GA 9.0
17+
:::
18+
19+
You can also specify multiple definitions in the same `:applies_to:` parameter. For example, `:applies_to: { ece:, ess: }` renders both ECE and ECH badges.

‎contribute-docs/syntax/admonitions.md‎

Lines changed: 1 addition & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -152,66 +152,5 @@ It can *span* multiple lines and supports inline formatting.
152152

153153
## Applies to information
154154

155-
Admonitions support the `applies_to` property to indicate which products or versions the information applies to.
156-
157-
:::::{tab-set}
158-
159-
::::{tab-item} Output
160-
161-
:::{note}
162-
:applies_to: stack: ga 9.1.0
163-
164-
This note applies to the Elastic Stack GA version 9.1.0.
165-
:::
166-
167-
:::{warning}
168-
:applies_to: serverless: ga
169-
170-
This warning applies to serverless GA.
155+
:::{include} _snippets/applies-to-admonitions.md
171156
:::
172-
173-
:::{tip}
174-
:applies_to: { ess:, ece: }
175-
176-
This tip applies to ECH and ECE.
177-
:::
178-
179-
:::{important}
180-
:applies_to: {"stack": "ga 9.2, preview 9.1", "serverless": "ga"}
181-
182-
This important note applies to Elastic Stack GA version 9.2 and Elastic Stack Preview version 9.1. It also applies to serverless GA.
183-
:::
184-
185-
::::
186-
187-
::::{tab-item} Markdown
188-
189-
```markdown
190-
:::{note}
191-
:applies_to: stack: ga 9.1.0
192-
193-
This note applies to the Elastic Stack GA version 9.1.0.
194-
:::
195-
196-
:::{warning}
197-
:applies_to: serverless: ga
198-
199-
This warning applies to serverless GA.
200-
:::
201-
202-
:::{tip}
203-
:applies_to: { ess:, ece: }
204-
205-
This tip applies to ECH and ECE.
206-
:::
207-
208-
:::{important}
209-
:applies_to: {"stack": "ga 9.2, preview 9.1", "serverless": "ga"}
210-
211-
This important note applies to Elastic Stack GA version 9.2 and Elastic Stack Preview version 9.1. It also applies to serverless GA.
212-
:::
213-
```
214-
215-
::::
216-
217-
:::::

‎contribute-docs/syntax/dropdowns.md‎

Lines changed: 1 addition & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -53,30 +53,9 @@ Dropdown content
5353

5454
## With applies_to badge
5555

56-
You can add an applies_to badge to the dropdown title by specifying the `:applies_to:` option. This displays a badge indicating which deployment types, versions, or other applicability criteria the dropdown content applies to.
57-
58-
:::::{tab-set}
59-
60-
::::{tab-item} Output
61-
62-
:::{dropdown} Dropdown Title
63-
:applies_to: stack: ga 9.0
64-
Dropdown content for Stack GA 9.0
56+
:::{include} _snippets/applies-to-dropdowns.md
6557
:::
6658

67-
::::
68-
69-
::::{tab-item} Markdown
70-
```markdown
71-
:::{dropdown} Dropdown Title
72-
:applies_to: stack: ga 9.0
73-
Dropdown content for Stack GA 9.0
74-
:::
75-
```
76-
::::
77-
78-
:::::
79-
8059
## Multiple applies_to definitions
8160

8261
You can specify multiple `applies_to` definitions using YAML object notation with curly braces `{}`. This is useful when content applies to multiple deployment types or versions simultaneously.

0 commit comments

Comments
 (0)