Skip to content

Commit 68e09dd

Browse files
committed
Consolidate landing page and remove redundant contribute-index
1 parent 859b923 commit 68e09dd

File tree

3 files changed

+23
-41
lines changed

3 files changed

+23
-41
lines changed

contribute-docs/contribute-index.md

Lines changed: 0 additions & 34 deletions
This file was deleted.

contribute-docs/index.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,38 @@ navigation_title: Contribute to the docs
44

55
# Contribute to Elastic documentation
66

7-
Find the relevant pages for contributing to the official Elastic documentation.
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.
88

9-
## Contribute to current docs
9+
This documentation site includes docs for
10+
- {{stack}} 9.x
11+
- {{ece}} 4.x
12+
- {{eck}} 3.x
13+
- All unversioned products like {{ech}} and {{serverless-full}}.
14+
15+
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.
1016

11-
We have two distinct systems for contributing to the current Elastic docs:
17+
:::{tip}
18+
To learn more about the new docs UX, read [how to use the documentation](/get-started/howto-use-the-docs.md).
19+
:::
20+
21+
## Contribute to current docs
1222

1323
|System|What it covers|Published at|Format|How to contribute
1424
|----|----|----|----|----|----|
15-
|Main docs|Guides, Troubleshooting, release notes, etc.|[elastic.co/docs](https://www.elastic.co/docs)|Markdown+|- [Contribution guide](./contribute-index.md) <br><br> - [Syntax guide](./syntax/index.md)|
16-
|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)|
25+
|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)|
26+
|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)|
1727

1828
:::{note}
19-
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).
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).
2030
:::
2131

32+
## Report issues or request features
33+
34+
|Issue type|Where to report|
35+
|----|----|
36+
|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)|
37+
|`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)|
38+
2239
## Contribute to legacy docs
2340

2441
|System|What it covers|Published at|Format/toolchain|How to contribute

contribute-docs/toc.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
toc:
22
- file: index.md
3-
- file: contribute-index.md
43
- file: on-the-web.md
54
- file: locally.md
65
- folder: syntax

0 commit comments

Comments
 (0)