Skip to content

Commit 1f68530

Browse files
address some feedback from @bmorelli's first round of review
1 parent 9aa5287 commit 1f68530

File tree

6 files changed

+53
-148
lines changed

6 files changed

+53
-148
lines changed

docs/_snippets/applies_to-key.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
11
`applies_to` accepts the following keys in this structure:
22

3+
* `serverless`: Applies to [Elastic Cloud Serverless](https://www.elastic.co/docs/deploy-manage/deploy/elastic-cloud/serverless).
4+
* `security`: Applies to Serverless [security projects](https://www.elastic.co/docs/solutions/security/get-started/create-security-project).
5+
* `elasticsearch`: Applies to Serverless [search projects](https://www.elastic.co/docs/solutions/search/serverless-elasticsearch-get-started).
6+
* `observability`: Applies to Serverless [observability projects](https://www.elastic.co/docs/solutions/observability/get-started).
37
* `stack`: Applies to the [Elastic Stack](https://www.elastic.co/docs/get-started/the-stack) including any Elastic Stack components.
48
* `deployment`: Applies to some deployment type(s).
5-
* `eck`: Applies to [Elastic Cloud on Kubernetes](https://www.elastic.co/docs/deploy-manage/deploy/cloud-on-k8s) deployments.
69
* `ech`: Applies to [Elastic Cloud Hosted](https://www.elastic.co/docs/deploy-manage/deploy/elastic-cloud/cloud-hosted) deployments.
710
* `ece`: Applies to [Elastic Cloud Enterprise](https://www.elastic.co/docs/deploy-manage/deploy/cloud-enterprise) deployments.
11+
* `eck`: Applies to [Elastic Cloud on Kubernetes](https://www.elastic.co/docs/deploy-manage/deploy/cloud-on-k8s) deployments.
812
* `self`: Applies to [self-managed](https://www.elastic.co/docs/deploy-manage/deploy/self-managed) deployments.
913
* `ess`: Applies to Elasticsearch Service deployments. {applies_to}`product: deprecated`
1014
:::{note}
1115
Use `ech` instead.
1216
:::
13-
* `serverless`: Applies to [Elastic Cloud Serverless](https://www.elastic.co/docs/deploy-manage/deploy/elastic-cloud/serverless).
14-
* `security`: Applies to Serverless [security projects](https://www.elastic.co/docs/solutions/security/get-started/create-security-project).
15-
* `elasticsearch`: Applies to Serverless [search projects](https://www.elastic.co/docs/solutions/search/serverless-elasticsearch-get-started).
16-
* `observability`: Applies to Serverless [observability projects](https://www.elastic.co/docs/solutions/observability/get-started).
1717
* `product`: Applies to a specific product.
18-
* `ecctl`: Applies to [Elastic cloud control](https://www.elastic.co/docs/reference/ecctl).
19-
* `curator`: Applies to [Elasticsearch Curator](https://www.elastic.co/docs/reference/elasticsearch/curator).
2018
* `apm_agent_dotnet`: Applies to the [Elastic APM .NET agent](https://www.elastic.co/docs/reference/apm/agents/dotnet).
2119
* `apm_agent_go`: Applies to the [Elastic APM Go agent](https://www.elastic.co/docs/reference/apm/agents/go).
2220
* `apm_agent_java`: Applies to the [Elastic APM Java agent](https://www.elastic.co/docs/reference/apm/agents/java).
@@ -25,12 +23,14 @@
2523
* `apm_agent_python`: Applies to the [Elastic APM Python agent](https://www.elastic.co/docs/reference/apm/agents/python).
2624
* `apm_agent_ruby`: Applies to the [Elastic APM Ruby agent](https://www.elastic.co/docs/reference/apm/agents/ruby).
2725
* `apm_agent_rum`: Applies to the [APM RUM JavaScript agent](https://www.elastic.co/docs/reference/apm/agents/rum-js).
28-
* `edot_collector`: Applies to the [Elastic Distribution of OpenTelemetry Collector](https://www.elastic.co/docs/reference/opentelemetry/edot-collector/).
29-
* `edot_ios`: Applies to the [Elastic Distribution of OpenTelemetry iOS](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/ios/).
30-
* `edot_android`: Applies to the [Elastic Distribution of OpenTelemetry Android](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/android/).
31-
* `edot_dotnet`: Applies to the [Elastic Distribution of OpenTelemetry .NET](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/dotnet/).
32-
* `edot_java`: Applies to the [Elastic Distribution of OpenTelemetry Java](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/java/).
33-
* `edot_node`: Applies to the [Elastic Distribution of OpenTelemetry Node.js](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/nodejs/).
34-
* `edot_php`: Applies to the [Elastic Distribution of OpenTelemetry PHP](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/php/).
35-
* `edot_python`: Applies to the [Elastic Distribution of OpenTelemetry Python](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/python/).
36-
* `edot_cf_aws`: Applies to the [Elastic Distribution of OpenTelemetry Cloud Forwarder](https://www.elastic.co/docs/reference/opentelemetry/edot-cloud-forwarder/).
26+
* `curator`: Applies to [Elasticsearch Curator](https://www.elastic.co/docs/reference/elasticsearch/curator) (Curator).
27+
* `ecctl`: Applies to [Elastic cloud control](https://www.elastic.co/docs/reference/ecctl) (ECCTL).
28+
* `edot_android`: Applies to the [Elastic Distribution of OpenTelemetry Android](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/android/) (EDOT Android).
29+
* `edot_cf_aws`: Applies to the [Elastic Distribution of OpenTelemetry Cloud Forwarder](https://www.elastic.co/docs/reference/opentelemetry/edot-cloud-forwarder/) (EDOT Cloud Forwarder).
30+
* `edot_collector`: Applies to the [Elastic Distribution of OpenTelemetry Collector](https://www.elastic.co/docs/reference/opentelemetry/edot-collector/) (EDOT Collector).
31+
* `edot_dotnet`: Applies to the [Elastic Distribution of OpenTelemetry .NET](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/dotnet/) (EDOT .NET).
32+
* `edot_ios`: Applies to the [Elastic Distribution of OpenTelemetry iOS](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/ios/) (EDOT iOS).
33+
* `edot_java`: Applies to the [Elastic Distribution of OpenTelemetry Java](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/java/) (EDOT Java).
34+
* `edot_node`: Applies to the [Elastic Distribution of OpenTelemetry Node.js](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/nodejs/) (EDOT Node.js).
35+
* `edot_php`: Applies to the [Elastic Distribution of OpenTelemetry PHP](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/php/) (EDOT PHP).
36+
* `edot_python`: Applies to the [Elastic Distribution of OpenTelemetry Python](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/python/) (EDOT Python).

docs/contribute/cumulative-docs/best-practices.md

Lines changed: 8 additions & 132 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,11 @@ Depending on what you're trying to communicate, you can use the following patter
2727

2828
## Order of items
2929

30-
**Versions.** Always put the newest version first when listing multiple versions. As a result, the lifecycles should be in order of product development progression, too.
30+
% TO DO: Open an issue to force the order in the code.
31+
32+
**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.
33+
34+
<image>
3135

3236
% Reference: https://elastic.github.io/docs-builder/versions/#defaults-and-hierarchy
3337
% Needs work...
@@ -36,6 +40,8 @@ Depending on what you're trying to communicate, you can use the following patter
3640
* **Deployment types**: Elastic Cloud Serverless, Elastic Cloud Hosted, Elastic Cloud on Kubernetes, Elastic Cloud Enterprise, Self-managed
3741
* **Monitoring for Java applications**: Elastic Distribution of OpenTelemetry (EDOT) Java, APM Java agent
3842

43+
<image>
44+
3945
## Placement of badges
4046

4147
### Headings
@@ -83,7 +89,7 @@ Do **not** put the `applies_to` badge at the beginning or end of the definition
8389

8490
#### If the badge is only relevant to a portion of the definition, follow the appropriate placement guidelines for the elements used in the definition [definition-list-item-part]
8591

86-
This might include labeling just one of multiple paragraphs or one item in an ordered or unordered list. For example, on the ... page, ...
92+
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.
8793

8894
::::{image} ./images/definition-list-portion-correct.png
8995
:screenshot:
@@ -178,133 +184,3 @@ To specify `applies_to` information for a code block, refer to [](/contribute/cu
178184
### Images
179185

180186
To specify `applies_to` information for an image, refer to [](/contribute/cumulative-docs/content-patterns.md#screenshot).
181-
182-
<!-- ### Stepper -->
183-
184-
<!-- ## Scenarios [scenarios]
185-
186-
There are several scenarios you will likely run into at some point when contributing to the docs.
187-
188-
### Feature in beta or technical preview is removed [beta-preview-removed]
189-
190-
If a feature in beta or technical preview is removed without going GA,
191-
[list both || remove the beta/preview version]
192-
in the `applies_to` badge.
193-
194-
% TO DO: Copy over example content https://github.com/elastic/kibana/pull/229485/files#r2231843057
195-
**Example: A beta option was removed one minor after it was introduced**
196-
197-
::::{tab-set}
198-
:::{tab-item} Visual
199-
:::
200-
:::{tab-item} Syntax
201-
:::
202-
::::
203-
204-
### Code block change between versions [code-blocks]
205-
206-
If the content of a code block changes between versions,
207-
you have a couple options depending on the nature of the change.
208-
209-
#### Content is added or removed [code-blocks-added-removed]
210-
211-
Use code callouts to point out lines that have changed over time.
212-
213-
**Example: One new option is available**
214-
215-
::::{tab-set}
216-
:::{tab-item} Visual
217-
:::
218-
:::{tab-item} Syntax
219-
:::
220-
::::
221-
222-
#### Content is replaced [code-blocks-replaced]
223-
224-
Use a tab for each version that contains a change.
225-
226-
**Example**
227-
228-
::::{tab-set}
229-
:::{tab-item} Visual
230-
:::
231-
:::{tab-item} Syntax
232-
:::
233-
::::
234-
235-
### Adjacent block elements change between versions [adjacent-block-elements]
236-
237-
**Example**
238-
239-
::::{tab-set}
240-
:::{tab-item} Visual
241-
:::
242-
:::{tab-item} Syntax
243-
:::
244-
::::
245-
246-
### Images change between versions [images]
247-
248-
#### Screenshots
249-
250-
Follow these principles to use screenshots in our unversioned documentation system:
251-
252-
* Reduce screenshots when they don’t explicitly add value.
253-
* When adding a screenshot, determine the minimum viable screenshot and whether it can apply to all relevant versions.
254-
* Take and maintain screenshots for only the most recent version, with very few exceptions that should be considered on a case-by-case basis.
255-
* In case of doubt, prioritize serverless.
256-
257-
**Example**
258-
259-
::::{tab-set}
260-
:::{tab-item} Visual
261-
:::
262-
:::{tab-item} Syntax
263-
:::
264-
::::
265-
266-
### UI changes between versions [ui]
267-
268-
**Example**
269-
270-
::::{tab-set}
271-
:::{tab-item} Visual
272-
:::
273-
:::{tab-item} Syntax
274-
:::
275-
::::
276-
277-
### One sentence in a paragraph changes between versions [inline-elements]
278-
279-
**Example**
280-
281-
::::{tab-set}
282-
:::{tab-item} Visual
283-
:::
284-
:::{tab-item} Syntax
285-
:::
286-
::::
287-
288-
### Table columns, rows, or cells change between versions
289-
290-
#### Content is added or removed
291-
292-
**Example**
293-
294-
::::{tab-set}
295-
:::{tab-item} Visual
296-
:::
297-
:::{tab-item} Syntax
298-
:::
299-
::::
300-
301-
#### Content is replaced
302-
303-
**Example**
304-
305-
::::{tab-set}
306-
:::{tab-item} Visual
307-
:::
308-
:::{tab-item} Syntax
309-
:::
310-
:::: -->

docs/contribute/cumulative-docs/content-patterns.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,25 +119,47 @@ Sibling pages are a last resort when no other solutions are appropriate.
119119
**Best practices**:
120120

121121
**Example**:
122+
* [Cloud Hosted deployment billing dimensions](https://elastic.co/docs/deploy-manage/cloud-organization/billing/cloud-hosted-deployment-billing-dimensions)
123+
* [{{serverless-short}} project billing dimensions](https://elastic.co/docs/deploy-manage/cloud-organization/billing/serverless-project-billing-dimensions)
122124

123125
## Screenshots vary [screenshot]
124126

127+
Sometimes the UI differs between versions, deployment types or other conditions.
128+
125129
### Solution A: Use tabs [screenshot-tabs]
126130

127131
**When to use tabs**:
132+
* When the screenshot shows significantly different interfaces or workflows for each product, deployment type, or version.
133+
* When the screenshot represents a specific, interactive action, like clicking a button or navigating a UI that changes meaningfully between contexts.
128134

129135
**Best practices**:
136+
* Keep any explanatory text outside the tab unless it's specific to the screenshot inside.
130137

131138
**Example**:
132139

140+
A walkthrough for configuring alerts in Kibana differs between Elastic Stack and Serverless deployments.
141+
142+
<image>
143+
133144
### Solution B: Add a note [screenshot-note]
134145

146+
In cases where only a small visual detail differs (for example, a button label or icon), it’s often more efficient to add a note rather than creating tabbed screenshots.
147+
135148
**When to use a note**:
149+
* When the screenshot is mostly consistent, but includes minor visual or behavioral differences.
150+
* When adding another screenshot would be redundant or distracting.
136151

137152
**Best practices**:
153+
* Keep notes concise, ideally one sentence.
154+
* Place the note directly after the screenshot.
155+
* Use an `applies_to` badge at the start of the note if relevant.
138156

139157
**Example**:
140158

159+
In Serverless, the "Create rule" button is labeled "Add rule."
160+
161+
<image>
162+
141163
## Multiple adjacent block elements vary [multiple-block]
142164

143165
### Solution A: Use headings [multiple-block-headings]
@@ -151,11 +173,18 @@ Sibling pages are a last resort when no other solutions are appropriate.
151173
### Solution B: Use tabs [multiple-block-tabs]
152174

153175
**When to use tabs**:
176+
* When the content is structurally similar but differs in detail — for example, slightly different instructions, outputs, or paths.
177+
* When you want to avoid repeating most of the surrounding content and isolate just the difference.
154178

155179
**Best practices**:
180+
* Only include content that varies inside the tab — don’t wrap entire pages or unrelated information.
181+
* Keep tabs short and focused to reduce cognitive load.
182+
* Label tabs clearly and consistently (e.g., by version or product).
156183

157184
**Example**:
158185

186+
<image>
187+
159188
## Feature in beta or technical preview is removed [beta-removed]
160189

161190
### Solution [beta-removed-solution]
Binary file not shown.
81.5 KB
Loading
Binary file not shown.

0 commit comments

Comments
 (0)