Skip to content

Commit f09b08e

Browse files
committed
add docs
Signed-off-by: bmorelli25 <[email protected]>
1 parent 57bd05a commit f09b08e

File tree

1 file changed

+26
-11
lines changed

1 file changed

+26
-11
lines changed

docs/contribute/cumulative-docs/guidelines.md

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -115,22 +115,37 @@ You generally do not need to tag:
115115

116116
### Versions
117117

118-
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.
118+
When listing multiple versions, author the newest version first whenever possible. This keeps files consistent and easier to maintain.
119+
Regardless of the source file, the build system automatically builds badge lifecycles in reverse chronological order.
120+
This means that badges will always appear to users from newest to oldest, which is the reverse of the product development timeline.
119121

120-
% TO DO: Add example / image
121-
% <image>
122+
For example:
123+
124+
{applies_to}`stack: preview 9.0.5, beta 9.1, ga 9.2`
122125

123-
% Reference: https://elastic.github.io/docs-builder/versions/#defaults-and-hierarchy
124-
% Needs work...
125126
### Keys
126127

127-
Always list [keys](/contribute/cumulative-docs/reference.md#key) in the same order for consistency. The order of keys should reflect organizational priorities. For example, use the following order:
128-
* **Serverless/Elastic Stack**: Serverless, Stack
129-
* **Deployment types**: Elastic Cloud Serverless, Elastic Cloud Hosted, Elastic Cloud on Kubernetes, Elastic Cloud Enterprise, Self-managed
130-
* **Monitoring for Java applications**: Elastic Distribution of OpenTelemetry (EDOT) Java, APM Java agent
128+
The build system automatically orders multiple [keys](/contribute/cumulative-docs/reference.md#key) in a consistent pattern. This reduces authoring overhead and makes content easier for users to scan.
129+
130+
:::{important}
131+
Key ordering only occurs if all keys are declared in the same directive. Keys declared seperately, for example: ``` {applies_to}`stack: ga` {applies_to}`serverless: preview` ```, will not be reordered by docs-builder.
132+
:::
133+
134+
Keys are ordered as follows:
131135

132-
% TO DO: Add example / image
133-
% <image>
136+
1. **Stack/Serverless**: Stack, Serverless
137+
2. **Deployment types**: ECH (Elastic Cloud Hosted), ECK (Elastic Cloud on Kubernetes), ECE (Elastic Cloud Enterprise), Self-Managed
138+
3. **ProductApplicability**: ECCTL, Curator, EDOT items (alphabetically), APM Agent items (alphabetically)
139+
140+
For example:
141+
142+
```{applies_to}
143+
deployment:
144+
ece: ga
145+
self: ga
146+
stack: ga
147+
serverless: ga
148+
```
134149

135150
## Product and deployment model applicability [products-and-deployment-models]
136151

0 commit comments

Comments
 (0)