Skip to content

Commit 90ac5a4

Browse files
committed
Rename legacy-docs to asciidoc-guide, remove .md from docs-builder URLs
1 parent c8fae3f commit 90ac5a4

File tree

9 files changed

+34
-26
lines changed

9 files changed

+34
-26
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
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.
22

33
Docs for {{stack}} 8.x, {{ece}} 3.x, and {{eck}} 2.x can all be found on this site.

contribute-docs/_snippets-contribute/two-systems.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
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.
22

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).
44

55
:::{tip}
66
Unversioned products, such as {{ech}} and {{serverless-full}}, are documented on [elastic.co/docs](https://www.elastic.co/docs).

contribute-docs/legacy-docs.md renamed to contribute-docs/asciidoc-guide.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
navigation_title: Contribute to legacy docs
2+
navigation_title: Contribute to Asciidoc docs
33
---
44

5-
# Contribute to legacy documentation
5+
# Contribute to `elastic.co/guide` (Asciidoc)
66

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).
88

99
This system uses the [ASCIIDoc](https://asciidoc.org/) markup language.
1010

11-
The following versions are considered legacy and use this system:
11+
The following versions use this system:
1212

1313
- {{stack}}: `8.x` and earlier
1414
- {{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
3131

3232
## Contribute locally
3333

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).
3535

3636
## Updating docs in both systems
3737

@@ -44,4 +44,4 @@ If you need to merge changes that are published in both systems (usually because
4444
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.
4545
4. Follow the steps in [Contribute on the web](#contribute-on-the-web) to publish your changes.
4646
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.

contribute-docs/index.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,32 @@ navigation_title: Contribute to the docs
44

55
# Contribute to Elastic documentation
66

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.
88

9-
This documentation site includes docs for
9+
This documentation site includes docs for:
1010
- {{stack}} 9.x
1111
- {{ece}} 4.x
1212
- {{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.
1417

1518
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.
1619

1720
:::{tip}
1821
To learn more about the new docs UX, read [how to use the documentation](/get-started/howto-use-the-docs.md).
1922
:::
2023

21-
## Contribute to current docs
24+
## Contribute to `elastic.co/docs` (Markdown)
2225

2326
|System|What it covers|Published at|Format|How to contribute
2427
|----|----|----|----|----|----|
2528
|Main docs|Guides, troubleshooting, release notes, etc.|[elastic.co/docs](https://www.elastic.co/docs)|Markdown|- [On the web](on-the-web.md) (quick edits) <br> - [Locally](locally.md) (complex changes) <br> - [Syntax guide](syntax/index.md)|
2629
|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)|
2730

2831
:::{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).
3033
:::
3134

3235
## Report issues or request features
@@ -36,8 +39,8 @@ If you need to update documentation in both the current and legacy systems, you'
3639
|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)|
3740
|`docs-builder`|- [Bug report](https://github.com/elastic/docs-builder/issues/new?template=bug-report.yaml) <br> - [Discussion](https://github.com/elastic/docs-builder/discussions)|
3841

39-
## Contribute to legacy docs
42+
## Contribute to `elastic.co/guide` (Asciidoc)
4043

4144
|System|What it covers|Published at|Format/toolchain|How to contribute
4245
|----|----|----|----|----|----|
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)|

contribute-docs/locally.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ This documentation is **cumulative**. This means that a new set of docs is not p
113113

114114
## Build the docs
115115

116-
Before pushing your changes, verify all of them locally .
116+
Before pushing your changes, verify them locally by running:
117117

118118
```
119119
docs-builder
@@ -130,7 +130,7 @@ After you've made your changes locally:
130130

131131
## Preview locally [#local-docs-preview]
132132

133-
Static-site generators like docs-builder can serve docs locally. This means you can edit the source and see the result in the browser in real time.
133+
`docs-builder` can serve docs locally. This means you can edit the source and see the result in the browser in real time.
134134

135135
To serve the local copy of the documentation in your browser, follow these steps:
136136

contribute-docs/on-the-web.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ For more details on editing files on GitHub, refer to [GitHub's documentation on
3030
:::{include} _snippets-contribute/tagged-warning.md
3131
:::
3232

33-
## Editing legacy docs
33+
## Editing `elastic.co/guide` docs (Asciidoc)
3434

35-
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.
3636

contribute-docs/syntax/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ The [quick reference](quick-ref.md) provides a cheat sheet of commonly used synt
88

99
## Full syntax reference
1010

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/).
1212

13-
## Contributing to legacy docs
13+
## Contributing to `elastic.co/guide` (Asciidoc)
1414

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).

contribute-docs/syntax/quick-ref.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,9 @@ A default anchor is automatically created for each [heading](#headings), in the
114114

115115
## Applies to
116116

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.
118120

119121
**Example: Section tag**
120122

@@ -134,7 +136,11 @@ stack:
134136
```
135137
:::
136138

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+
:::
138144

139145
<!--
140146
:::{tip}
@@ -152,7 +158,6 @@ The `applies_to` tags are scope signals for readers, not comprehensive metadata.
152158
**DON'Ts**<br>
153159
**Don't:** Include `applies_to` tags in admonitions<br>
154160
**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)
156161
<br>
157162
<br>
158163

contribute-docs/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ toc:
3030
- file: kibana-api-docs-quickstart.md
3131
- file: workflows.md
3232
- file: help.md
33-
- file: legacy-docs.md
33+
- file: asciidoc-guide.md

0 commit comments

Comments
 (0)