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/contribute/cumulative-docs/badge-placement.md
+5Lines changed: 5 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,6 +37,8 @@ For example, in the [Semantic text field type](https://www.elastic.co/docs/refer
37
37
:alt: Correct use of applies_to with headings
38
38
::::
39
39
40
+
% FOR THE REVIEWER: IS THIS TRUE?
41
+
% What do you think of allowing inline applies_to in headings as long as there is only one badge?
40
42
:::{warning}
41
43
Do **not** use [inline annotations](/syntax/applies.md#inline-annotations) with headings, which will cause rendering issues in _On this page_.
42
44
@@ -96,6 +98,9 @@ For example, the [Alerting and action settings in Kibana](https://www.elastic.co
96
98
:alt:
97
99
::::
98
100
101
+
% FOR THE REVIEWER: THOUGHTS?
102
+
% This is what I'm seeing in the currently published docs,
103
+
% but I'm not sure if this is what we want to recommend.
99
104
#### If the list just happens to have one or more items that are only relevant to a specific situation, put the badge at the end of the list item [list-other]
100
105
101
106
Placing the badge at the end of the list item maintains the flow of the list without distracting the reader with badges while still making it clear that the content in that list item is only applicable to the specified situation.
Copy file name to clipboardExpand all lines: docs/contribute/cumulative-docs/example-scenarios.md
+54-26Lines changed: 54 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,12 +20,36 @@ the Serverless UI, add both the `stack` and `serverless` keys to the `applies_to
20
20
21
21
% ## Content on orchestrating, deploying, or configuring an installation
22
22
23
-
## Only one section applies [one-section]
23
+
## Section applicability differs from page applicability [page-section-varies]
24
24
25
-
The whole page is generally applicable to all deployment types, but one specific paragraph
26
-
only applies to Elastic Cloud Hosted and Serverless, and another paragraph only applies to
27
-
Elastic Cloud Enterprise:
25
+
When only one section has different applicability than the applicability indicated at the
26
+
page level in the frontmatter, use section-level `applies_to` badges.
28
27
28
+
### If a section applies [one-section]
29
+
30
+
For example, the content on the [Security](https://www.elastic.co/docs/deploy-manage/security) page is generally applicable to all deployment types, but the first section only applies to Elastic Cloud Hosted and Serverless:
31
+
32
+
* In the frontmatter, specify that the content on the page applies to all deployment types unless otherwise specified.
33
+
* In a section-level annotation, specify that the content only applies to `ech` and `serverless`.
34
+
35
+
:::{warning}
36
+
**Don’t overload with exclusions unless it is necessary.**
37
+
38
+
% FOR THE REVIEWER: IS THIS TRUE?
39
+
In this example, we expect the reader to understand that in sections where only some deployment types are listed,
40
+
the content is only applicable to the deployment types listed in the section-level annotation
41
+
(and is _not_ applicable to the deployment types that are listed at the page level,
Likewise, when the difference is specific to just one paragraph or list item, the same rules apply.
64
-
Just the syntax slightly differs so that it stays inline: `` {applies_to}`ess: ga` {applies_to}`serverless: ga` ``.
65
-
66
-
78
+
Just the syntax slightly differs so that it stays inline: `` {applies_to}`ech: ga` {applies_to}`serverless: ga` ``.
67
79
:::
68
80
69
-
##Only one section does _not_ apply [not-one-section]
81
+
### If one section does _not_ apply [not-one-section]
70
82
71
83
A whole page is generally applicable to Elastic Stack 9.0.0 and to Serverless,
72
84
but one specific section isn’t applicable to Serverless.
73
85
86
+
For example, the content on the [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) page is generally applicable to both Serverless and stateful, but one section only applies stateful:
87
+
88
+
* In the frontmatter, specify that the content on the page applies to both unless otherwise specified.
89
+
90
+
% FOR THE REVIEWER: WHICH IS CORRECT?
91
+
% The existing docs and the "real" example in the wild use different strategies.
92
+
% Do we include `stack: ga` in the section annotation or not?
93
+
* In a section-level annotation, specify that the content is `ga` in `stack` and is `unavailable` in `serverless`.
94
+
95
+
:::::{tab-set}
96
+
::::{tab-item} Image
97
+
:::{image} ./images/example-not-one-section.png
98
+
:screenshot:
99
+
:alt:
100
+
:::
101
+
::::
102
+
::::{tab-item} Code
74
103
````
75
104
---
76
105
applies_to:
@@ -85,17 +114,16 @@ applies_to:
85
114
## Configure a space-level landing page [space-landing-page]
86
115
87
116
```{applies_to}
117
+
stack: ga
88
118
serverless: unavailable
89
119
```
90
120
````
121
+
::::
122
+
:::::
91
123
92
124
% TO DO: Add real example
93
125
% <image>
94
126
95
-
:::{warning}
96
-
Don’t overload with exclusions unless it is necessary.
97
-
:::
98
-
99
127
:::{tip}
100
128
Likewise, when the difference is specific to just one paragraph or list item, the same rules apply.
101
129
Just the syntax slightly differs so that it stays inline: `` {applies_to}`serverless: unavailable` ``.
0 commit comments