Skip to content

Commit a534976

Browse files
clarify
1 parent abd55c8 commit a534976

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/contribute/cumulative-docs/badge-placement.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ At a high level, you should follow these badge placement principles:
2424

2525
## Specific elements
2626

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.
2828

2929
### Headings
3030

@@ -46,7 +46,6 @@ Do **not** use [inline annotations](/syntax/applies.md#inline-annotations) with
4646
::::
4747
:::
4848

49-
5049
### Definition lists
5150

5251
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
7372

7473
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.
7574

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).
76+
7677
::::{image} ./images/definition-list-portion-correct.png
7778
:screenshot:
7879
: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
153154
badge applies to the whole row.
154155
:::
155156

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]
157158

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).
159160

160161
::::{image} ./images/table-part-of-cell-correct.png
161162
:screenshot:

0 commit comments

Comments
 (0)