Skip to content

Commit 8a4f298

Browse files
address badge placement feedback
1 parent 272fa91 commit 8a4f298

File tree

6 files changed

+7
-28
lines changed

6 files changed

+7
-28
lines changed

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

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

2828
There are more specific guidelines on badge placement to follow when using specific elements.
2929

30-
### Headings
30+
### Headings [headings]
3131

3232
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.
3333

@@ -41,15 +41,15 @@ For example, in the [Semantic text field type](https://www.elastic.co/docs/refer
4141
% FOR THE REVIEWER: IS THIS TRUE?
4242
% What do you think of allowing inline applies_to in headings as long as there is only one badge?
4343
:::{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.
4545

4646
::::{image} ./images/heading-incorrect.png
4747
:screenshot:
4848
:alt: Rendering error when using inline applies_to with headings
4949
::::
5050
:::
5151

52-
### Definition lists
52+
### Definition lists [definition-lists]
5353

5454
The recommended placement of `applies_to` badges in definition lists varies based on what part(s) of the list item relate to the badge.
5555

@@ -75,20 +75,16 @@ Do **not** put the `applies_to` badge at the beginning or end of the definition
7575

7676
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.
7777

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

8080
::::{image} ./images/definition-list-portion-correct.png
8181
:screenshot:
8282
:alt: Correctly using inline applies_to in a portion of a definition list item
8383
::::
8484

85-
### Ordered and unordered lists
85+
### Ordered and unordered lists [ordered-and-unordered-lists]
8686

8787
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-
9288
This could mean distinguishing between deployment types, products, lifecycles, or versions.
9389
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.
9490

@@ -99,22 +95,6 @@ For example, the [Alerting and action settings in Kibana](https://www.elastic.co
9995
:alt:
10096
::::
10197

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
11898
### Tables
11999

120100
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
143123

144124
#### If the badge is relevant to one cell, add the badge to the cell it applies to [table-cell]
145125

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

148128
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.
149129

@@ -162,7 +142,7 @@ badge applies to the whole row.
162142

163143
#### 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]
164144

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

167147
::::{image} ./images/table-part-of-cell-correct.png
168148
:screenshot:

docs/contribute/cumulative-docs/guidelines.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,6 @@ refer to [](/syntax/applies.md).
8080
% Source: George's checklist
8181
* 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:
8282

83-
% TO DO: Open an issue to force the order in the code.
8483
### Order of items
8584

8685
**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.
-110 KB
Loading
6.34 KB
Loading
26.4 KB
Loading
-21.9 KB
Loading

0 commit comments

Comments
 (0)