You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contribute/cumulative-docs/guidelines.md
+26-11Lines changed: 26 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -115,22 +115,37 @@ You generally do not need to tag:
115
115
116
116
### Versions
117
117
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.
119
121
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`
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:
***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.
0 commit comments