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
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ At a high level, you should follow these badge placement principles:
24
24
25
25
## Specific elements
26
26
27
-
More specific guidance in common situations is outlined below.
27
+
There are more specific guidelines on badge placement to follow when using specific elements.
28
28
29
29
### Headings
30
30
@@ -46,7 +46,6 @@ Do **not** use [inline annotations](/syntax/applies.md#inline-annotations) with
46
46
::::
47
47
:::
48
48
49
-
50
49
### Definition lists
51
50
52
51
The recommended placement of `applies_to` badges in definition lists varies based what part(s) of the list item relate to the badge.
@@ -73,6 +72,8 @@ Do **not** put the `applies_to` badge at the beginning or end of the definition
73
72
74
73
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.
75
74
75
+
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).
:alt: Correctly using inline applies_to in a portion of a definition list item
@@ -153,9 +154,9 @@ using something other than a table (for example, a definition list) to avoid con
153
154
badge applies to the whole row.
154
155
:::
155
156
156
-
#### If the badge is relevant to part of a cell, add the badge to the end of the line it applies to[table-cell-part]
157
+
#### 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]
157
158
158
-
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.
159
+
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).
0 commit comments