Skip to content

Commit 662a029

Browse files
committed
Add note about cumulative docs docs
1 parent 960bdae commit 662a029

File tree

6 files changed

+36
-18
lines changed

6 files changed

+36
-18
lines changed

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

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
% Audience: Technical writers and other frequent docs contributors
2-
% Goals:
3-
% * Provide guidance on badge placement in specific situations
4-
51
# Badge usage and placement
62

3+
:::{note}
4+
This content is still in development.
5+
If you have questions about how to write cumulative documentation while contributing,
6+
reach out to **@elastic/docs** in the related GitHub issue or PR.
7+
:::
8+
79
As you continue contributing to documentation and more versions are released,
810
you might have questions about how to integrate `applies_to` badges in
911
cumulative documentation.

contribute-docs/how-to/cumulative-docs/example-scenarios.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,14 @@
22
navigation_title: Example scenarios
33
---
44

5-
% Audience: Technical writers and other frequent docs contributors
6-
% Goals:
7-
% * Provide realistic examples of situations with one or more solution
8-
95
# Cumulative docs example scenarios
106

7+
:::{note}
8+
This content is still in development.
9+
If you have questions about how to write cumulative documentation while contributing,
10+
reach out to **@elastic/docs** in the related GitHub issue or PR.
11+
:::
12+
1113
Browse common scenarios you might run into as a docs contributor that require different approaches to labeling cumulative docs.
1214

1315
:::{note}

contribute-docs/how-to/cumulative-docs/guidelines.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,14 @@
22
navigation_title: Guidelines
33
---
44

5-
% Audience: Anyone who contributes to docs
6-
% Goals:
7-
% * Provide guidance that is appropriate for new contributors
8-
95
# Cumulative docs guidelines
106

7+
:::{note}
8+
This content is still in development.
9+
If you have questions about how to write cumulative documentation while contributing,
10+
reach out to **@elastic/docs** in the related GitHub issue or PR.
11+
:::
12+
1113
Start by asking yourself:
1214

1315
* Does this content vary between products, versions, or deployment types?

contribute-docs/how-to/cumulative-docs/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Write cumulative documentation
22

3-
% Audience: Anyone who contributes to docs or is curious about the cumulative documentation model
4-
% Goals:
5-
% * Introduce the concept of cumulative documentation
6-
% * Explain its impacts on both readers and contributors
7-
% * Point docs contributors to more detailed resources on how to write cumulative documentation
3+
:::{note}
4+
This content is still in development.
5+
If you have questions about how to write cumulative documentation while contributing,
6+
reach out to **@elastic/docs** in the related GitHub issue or PR.
7+
:::
88

99
In [elastic.co/docs](https://elastic.co/docs) (Docs V3) we write docs cumulatively. This means that in our Markdown-based docs, there is no longer a new documentation set published with every minor release: the same page stays valid over time and shows version-related evolutions.
1010

11-
:::{note}
11+
:::{important}
1212
This new behavior starts with the following **versions** of our products: Elastic Stack 9.0, ECE 4.0, ECK 3.0, and even more like EDOT docs. It also includes our unversioned products: Serverless and Elastic Cloud.
1313

1414
Nothing changes for our ASCIIDoc-based documentation system, that remains published and maintained for the following versions: Elastic Stack until 8.x, ECE until 3.x, ECK until 2.x, etc.

contribute-docs/how-to/cumulative-docs/reference.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Quick reference
22

3+
:::{note}
4+
This content is still in development.
5+
If you have questions about how to write cumulative documentation while contributing,
6+
reach out to **@elastic/docs** in the related GitHub issue or PR.
7+
:::
8+
39
The `applies_to` directive uses the following format:
410

511
```

contribute-docs/how-to/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ Find practical guides for common documentation tasks.
44

55
## Write cumulative documentation
66

7+
:::{note}
8+
This content is still in development.
9+
If you have questions about how to write cumulative documentation while contributing,
10+
reach out to **@elastic/docs** in the related GitHub issue or PR.
11+
:::
12+
713
Learn about the cumulative documentation model and how to tag content for different versions and deployments.
814

915
- [Write cumulative documentation](cumulative-docs/index.md) - Overview and when to tag content

0 commit comments

Comments
 (0)