Skip to content

Commit 8494217

Browse files
soften guideline on badges taking up space
1 parent 7381dd1 commit 8494217

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

docs/contribute/cumulative-docs/guidelines.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,11 +90,9 @@ You generally do not need to tag:
9090

9191
% Source: Slack conversation
9292
* **Consider how badges take up space on the page**:
93-
The `applies_to` badges should not require contributors to add specific Markdown real estate
94-
to the page layout (such as a specific `Version` column in a table).
95-
Instead, contributors should be able to add them anywhere they need, and the system should
96-
be in charge of rendering them clearly.
97-
93+
Avoid badge placement patterns that take up unnecessary Markdown real estate.
94+
For example, adding a dedicated column for applicability in a table when only
95+
a few rows require an `applies_to` badge.
9896
% Source: George's checklist
9997
* **Use `unavailable` sparingly**:
10098
For example, if a page is only about Elastic Cloud Hosted, don't add a `serverless: unavailable` tag.

0 commit comments

Comments
 (0)