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
To contribute to elastic.co/guide, you must work with our [legacy documentation build system](https://github.com/elastic/docs). This system uses ASCIIDoc as its markup language.
1
+
To contribute to `elastic.co/guide` (Asciidoc), you must work with our [Asciidoc documentation build system](https://github.com/elastic/docs). This system uses ASCIIDoc as its markup language.
2
2
3
3
Docs for {{stack}} 8.x, {{ece}} 3.x, and {{eck}} 2.x can all be found on this site.
Copy file name to clipboardExpand all lines: contribute-docs/_snippets-contribute/two-systems.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
Because the new documentation site only hosts documentation for newer releases, the way that you contribute depends on the version that you want to document.
2
2
3
-
For a list of versions covered on [elastic.co/docs](https://www.elastic.co/docs), refer to [Find docs for your product version](https://www.elastic.co/docs/get-started/versioning-availability#find-docs-for-your-product-version). Versions prior to the versions listed on that page are documented on our legacy system, [elastic.co/guide](https://www.elastic.co/guide).
3
+
For a list of versions covered on [elastic.co/docs](https://www.elastic.co/docs) (Markdown), refer to [Find docs for your product version](https://www.elastic.co/docs/get-started/versioning-availability#find-docs-for-your-product-version). Versions prior to the versions listed on that page are documented on [elastic.co/guide](https://www.elastic.co/guide) (Asciidoc).
4
4
5
5
:::{tip}
6
6
Unversioned products, such as {{ech}} and {{serverless-full}}, are documented on [elastic.co/docs](https://www.elastic.co/docs).
Copy file name to clipboardExpand all lines: contribute-docs/asciidoc-guide.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
1
---
2
-
navigation_title: Contribute to legacy docs
2
+
navigation_title: Contribute to Asciidoc docs
3
3
---
4
4
5
-
# Contribute to legacy documentation
5
+
# Contribute to `elastic.co/guide` (Asciidoc)
6
6
7
-
To contribute to pages that live at [elastic.co/guide](https://www.elastic.co/guide/index.html), you must work with our [legacy documentation build system](https://github.com/elastic/docs).
7
+
To contribute to pages that live at [elastic.co/guide](https://www.elastic.co/guide/index.html), you must work with our [Asciidoc documentation build system](https://github.com/elastic/docs).
8
8
9
9
This system uses the [ASCIIDoc](https://asciidoc.org/) markup language.
10
10
11
-
The following versions are considered legacy and use this system:
11
+
The following versions use this system:
12
12
13
13
- {{stack}}: `8.x` and earlier
14
14
- {{ece}}: `3.x` and earlier
@@ -31,7 +31,7 @@ If you are working in a repo like Kibana or the cloud repo, backports can be com
31
31
32
32
## Contribute locally
33
33
34
-
For complex or multi-page updates to legacy documentation, refer to the [legacy documentation build guide](https://github.com/elastic/docs?tab=readme-ov-file#building-documentation).
34
+
For complex or multi-page updates to `elastic.co/guide` (Asciidoc) documentation, refer to the [Asciidoc documentation build guide](https://github.com/elastic/docs?tab=readme-ov-file#building-documentation).
35
35
36
36
## Updating docs in both systems
37
37
@@ -44,4 +44,4 @@ If you need to merge changes that are published in both systems (usually because
44
44
2. If you just need to port a specific section you can use: `pandoc -f gfm -t asciidoc ./<file-name>.md` and the output of the file will be in your command window from which you can copy.
45
45
4. Follow the steps in [Contribute on the web](#contribute-on-the-web) to publish your changes.
46
46
5. If the change is too large or complicated, create a new issue in the [`docs-content`](https://github.com/elastic/docs-content) or [`docs-content-internal`](https://github.com/elastic/docs-content-internal) repository detailing the changes made for the team to triage.
47
-
6. Merge the changes and close the issue once the updates are reflected in the documentation.
47
+
6. Merge the changes and close the issue (if applicable) once the updates are reflected in the documentation.
Copy file name to clipboardExpand all lines: contribute-docs/index.md
+10-7Lines changed: 10 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,29 +4,32 @@ navigation_title: Contribute to the docs
4
4
5
5
# Contribute to Elastic documentation
6
6
7
-
In April 2025, Elastic migrated to a new documentation system at [elastic.co/docs](https://www.elastic.co/docs), using Markdown and the [`docs-builder`](https://elastic.github.io/docs-builder/) toolchain.
7
+
In April 2025, Elastic migrated to a new documentation system at [elastic.co/docs](https://www.elastic.co/docs), using Markdown and the [`docs-builder`](https://elastic.github.io/docs-builder/) toolchain, which coincided with the release of {{stack}} 9.0.0, {{ece}} 4.0.0, and {{eck}} 3.0.0.
8
8
9
-
This documentation site includes docs for
9
+
This documentation site includes docs for:
10
10
- {{stack}} 9.x
11
11
- {{ece}} 4.x
12
12
- {{eck}} 3.x
13
-
- All unversioned products like {{ech}} and {{serverless-full}}.
13
+
- {{ech}}
14
+
- {{serverless-full}}
15
+
16
+
Refer to [versioning and availability](/get-started/versioning-availability.md) to learn more.
14
17
15
18
This documentation is [**cumulative**](how-to/cumulative-docs/index.md): a new set of docs is not published for every minor release. Instead, each page stays valid over time and incorporates version-specific changes.
16
19
17
20
:::{tip}
18
21
To learn more about the new docs UX, read [how to use the documentation](/get-started/howto-use-the-docs.md).
19
22
:::
20
23
21
-
## Contribute to current docs
24
+
## Contribute to `elastic.co/docs` (Markdown)
22
25
23
26
|System|What it covers|Published at|Format|How to contribute
|API references|Elastic REST APIs|[elastic.co/docs/api](https://www.elastic.co/docs/api/)|[OpenAPI](https://swagger.io/specification/)|[Contribute to API docs](api-docs/index.md)|
27
30
28
31
:::{note}
29
-
If you need to update documentation in both the current and legacy systems, you'll need two separate PRs. Refer to [Updating docs in both systems](legacy-docs.md#updating-docs-in-both-systems).
32
+
If you need to update documentation in both the MarkDown and Asciidoc systems, you'll need two separate PRs. Refer to [Updating docs in both systems](asciidoc-guide.md#updating-docs-in-both-systems).
30
33
:::
31
34
32
35
## Report issues or request features
@@ -36,8 +39,8 @@ If you need to update documentation in both the current and legacy systems, you'
36
39
|Documentation|- [Open a docs issue](https://github.com/elastic/docs-content/issues/new?template=internal-request.yaml) or [fix it yourself](locally.md) <br> - Elastic employees can use the [internal repo](https://github.com/elastic/docs-content-internal/issues/new/choose)|
|System|What it covers|Published at|Format/toolchain|How to contribute
42
45
|----|----|----|----|----|----|
43
-
|Legacy docs|Elastic docs & API references for 8.x and earlier|[elastic.co/guide](https://www.elastic.co/guide/index.html)|Asciidoc|[Contribute to legacy docs](./legacy-docs.md)|
46
+
|`elastic.co/guide` (Asciidoc)|Elastic docs & API references for 8.x and earlier|[elastic.co/guide](https://www.elastic.co/guide/index.html)|Asciidoc|[Contribute to the Asciidoc docs](./asciidoc-guide.md)|
If you need to contribute to [elastic.co/guide](https://elastic.co/guide) pages, refer to [Contribute to legacy documentation](legacy-docs.md) to learn about the asciidoc system.
35
+
If you need to contribute to [elastic.co/guide](https://elastic.co/guide) pages, refer to [Contribute to `elastic.co/guide` (Asciidoc)](asciidoc-guide.md) to learn about the Asciidoc system.
Copy file name to clipboardExpand all lines: contribute-docs/syntax/index.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,8 +8,8 @@ The [quick reference](quick-ref.md) provides a cheat sheet of commonly used synt
8
8
9
9
## Full syntax reference
10
10
11
-
For the complete syntax documentation, refer to the [full syntax reference](https://elastic.github.io/docs-builder/syntax/) in the `elastic/docs-builder` repository.
11
+
For the full syntax reference, go to [elastic.github.io/docs-builder/syntax/](https://elastic.github.io/docs-builder/syntax/).
12
12
13
-
## Contributing to legacy docs
13
+
## Contributing to `elastic.co/guide` (Asciidoc)
14
14
15
-
If you need to work on [elastic.co/guide](https://elastic.co/guide) pages (written in AsciiDoc), refer to [Contribute to legacy documentation](../legacy-docs.md).
15
+
If you need to work on [elastic.co/guide](https://elastic.co/guide) pages (written in AsciiDoc), refer to [Contribute to `elastic.co/guide` (Asciidoc)](../asciidoc-guide.md).
Copy file name to clipboardExpand all lines: contribute-docs/syntax/quick-ref.md
+8-3Lines changed: 8 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -114,7 +114,9 @@ A default anchor is automatically created for each [heading](#headings), in the
114
114
115
115
## Applies to
116
116
117
-
Tags that identify technical contexts: the feature base (stack/serverless), deployments, and project types that a piece of content "applies to." Use `applies_to` tags to help users determine whether content is right for their deployments and configuration. These tags are a [version content pattern](../how-to/cumulative-docs/example-scenarios.md) in Elastic Docs v3.
117
+
Use applies_to metadata to tag content for specific contexts, for example whether a feature is available on certain products, versions, or deployment types.
118
+
119
+
This metadata enables you to write [cumulative documentation](../how-to/cumulative-docs/index.md), because Elastic no longer publishes separate docs sets for every minor release.
118
120
119
121
**Example: Section tag**
120
122
@@ -134,7 +136,11 @@ stack:
134
136
```
135
137
:::
136
138
137
-
For full syntax and more examples, see [](https://elastic.github.io/docs-builder/syntax/applies).
139
+
For full syntax and more examples, refer to [the `applies_to` documentation](https://elastic.github.io/docs-builder/syntax/applies).
140
+
141
+
:::{tip}
142
+
The syntax for `applies_to` metadata differs depending on whether it's added at the [page level](https://elastic.github.io/docs-builder/syntax/applies/#page-level) (in frontmatter), [section level](https://elastic.github.io/docs-builder/syntax/applies/#section-level) (after a heading), or [inline](https://elastic.github.io/docs-builder/syntax/applies/#inline-level).
143
+
:::
138
144
139
145
<!--
140
146
:::{tip}
@@ -152,7 +158,6 @@ The `applies_to` tags are scope signals for readers, not comprehensive metadata.
152
158
**DON'Ts**<br>
153
159
❌ **Don't:** Include `applies_to` tags in admonitions<br>
154
160
❌ **Don't:** Add `applies_to` tags to general, broadly applicable content<br>
155
-
❌ **Don't:** Use `Coming (x.x.x)` tags, except in special cases (don't pre-announce features)
0 commit comments