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
+7-27Lines changed: 7 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ At a high level, you should follow these badge placement principles:
27
27
28
28
There are more specific guidelines on badge placement to follow when using specific elements.
29
29
30
-
### Headings
30
+
### Headings[headings]
31
31
32
32
Use [section annotations](/syntax/applies.md#section-annotations) on the next line after a heading when the entire content between that heading and the next [heading](/syntax/headings.md) of the same or higher level is version or product-specific.
33
33
@@ -41,15 +41,15 @@ For example, in the [Semantic text field type](https://www.elastic.co/docs/refer
41
41
% FOR THE REVIEWER: IS THIS TRUE?
42
42
% What do you think of allowing inline applies_to in headings as long as there is only one badge?
43
43
:::{warning}
44
-
Do **not** use [inline annotations](/syntax/applies.md#inline-annotations) with headings, which will cause rendering issues in _On this page_.
44
+
Do **not** use [inline annotations](/syntax/applies.md#inline-annotations) with headings.
45
45
46
46
::::{image} ./images/heading-incorrect.png
47
47
:screenshot:
48
48
:alt: Rendering error when using inline applies_to with headings
49
49
::::
50
50
:::
51
51
52
-
### Definition lists
52
+
### Definition lists[definition-lists]
53
53
54
54
The recommended placement of `applies_to` badges in definition lists varies based on what part(s) of the list item relate to the badge.
55
55
@@ -75,20 +75,16 @@ Do **not** put the `applies_to` badge at the beginning or end of the definition
75
75
76
76
This might include labeling just one of multiple paragraphs, or one item in an ordered or unordered list. For example, on the [Google Gemini Connector page](https://www.elastic.co/docs/reference/kibana/connectors-kibana/gemini-action-type#gemini-connector-configuration), the default model is different depending on the deployment type and version of the Elastic Stack. These differences should be called out with their own `applies_to` badges.
77
77
78
-
In this example, the `applies_to` badges should be at the beginning of each list item as described in [the guidelines for lists](#list-compare-applies_to).
78
+
In this example, the `applies_to` badges should be at the beginning of each list item as described in [the guidelines for lists](#ordered-and-unordered-lists).
:alt: Correctly using inline applies_to in a portion of a definition list item
83
83
::::
84
84
85
-
### Ordered and unordered lists
85
+
### Ordered and unordered lists[ordered-and-unordered-lists]
86
86
87
87
Reorganize content as needed so the `applies_to` badge is relevant to the entire contents of the list item.
88
-
The recommended placement of the badge varies based on the purpose of the list.
89
-
90
-
#### If the purpose of the list is to illustrate the difference between situations, put a badge at the start of each item [list-compare-applies_to]
91
-
92
88
This could mean distinguishing between deployment types, products, lifecycles, or versions.
93
89
Placing the badge at the beginning of the list item, allows the reader to scan the list for the item that is relevant to them.
94
90
@@ -99,22 +95,6 @@ For example, the [Alerting and action settings in Kibana](https://www.elastic.co
99
95
:alt:
100
96
::::
101
97
102
-
% FOR THE REVIEWER: THOUGHTS?
103
-
% This is what I'm seeing in the currently published docs,
104
-
% but I'm not sure if this is what we want to recommend.
105
-
#### 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]
106
-
107
-
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.
108
-
109
-
For example, the [Add filter controls](https://www.elastic.co/docs/explore-analyze/dashboards/add-controls) page lists ways to configure ES|QL controls. Only one of the ways they can be controlled was added for the first time in 9.1.0.
110
-
111
-
::::{image} ./images/list-misc-correct.png
112
-
:screenshot:
113
-
:alt:
114
-
::::
115
-
116
-
117
-
% Reference: Slack conversation
118
98
### Tables
119
99
120
100
The recommended placement in tables varies based on what part(s) of the table related to the `applies_to` label.
@@ -143,7 +123,7 @@ Instead, contributors should be able to add them anywhere they need, and the sys
143
123
144
124
#### If the badge is relevant to one cell, add the badge to the cell it applies to [table-cell]
145
125
146
-
Add the badge to the cell to indicate that it applies to that one cell only.
126
+
Add the badge to the end of the content in a cell to indicate that it applies to that one cell only.
147
127
148
128
For example, the [Collect application data](https://www.elastic.co/docs/solutions/observability/apm/collect-application-data#_capabilities) page includes a table that compares functionality across two methods for collecting APM data, and only one of the methods is in technical preview.
149
129
@@ -162,7 +142,7 @@ badge applies to the whole row.
162
142
163
143
#### If the badge is relevant to part of a cell, follow the appropriate placement guidelines for the elements used in the cell [table-cell-part]
164
144
165
-
For example, the [Parse AWS VPC Flow Log](https://www.elastic.co/docs/reference/beats/filebeat/processor-parse-aws-vpc-flow-log) page includes new information relevant to 9.2.0 and later about a setting that already existed before 9.2.0. In this example, the `applies_to` badges should be at the beginning of each list item as described in [the guidelines for lists](#list-compare-applies_to).
145
+
For example, the [Parse AWS VPC Flow Log](https://www.elastic.co/docs/reference/beats/filebeat/processor-parse-aws-vpc-flow-log) page includes new information relevant to 9.2.0 and later about a setting that already existed before 9.2.0. In this example, the `applies_to` badges should be at the beginning of each list item as described in [the guidelines for lists](#ordered-and-unordered-lists).
Copy file name to clipboardExpand all lines: docs/contribute/cumulative-docs/guidelines.md
-1Lines changed: 0 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -80,7 +80,6 @@ refer to [](/syntax/applies.md).
80
80
% Source: George's checklist
81
81
* Don’t overload with exclusions unless it is necessary - If a page is only about Elastic Cloud Hosted, no need to say serverless: unavailable, just add deployment: ess:
82
82
83
-
% TO DO: Open an issue to force the order in the code.
84
83
### Order of items
85
84
86
85
**Versions.** Always put the newest version first when listing multiple versions. As a result, the lifecycles should be in reverse order of product development progression, too.
0 commit comments