Skip to content

Commit 70347b2

Browse files
committed
tighten up contribute/index.md
1 parent b4f665f commit 70347b2

File tree

2 files changed

+18
-31
lines changed

2 files changed

+18
-31
lines changed

contribute-docs/contribute/_snippets/docs-intro.md

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

contribute-docs/contribute/index.md

Lines changed: 18 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,41 +2,33 @@
22
navigation_title: Contribute to main docs
33
---
44

5-
# Elastic Docs contribution guide
5+
# Contribute to current Elastic docs
66

7-
Welcome, **contributor**!
7+
In April 2025, Elastic migrated to a new documentation system, publishing docs at [elastic.co/docs](https://www.elastic.co/docs). This new system uses Markdown and a modern toolchain called [Docs V3](https://elastic.github.io/docs-builder/).
88

9-
Whether you're a technical writer or you've only edited Elastic docs once or twice, you're a valued contributor. Every word matters!
9+
Docs for {{stack}} 9.x, {{ece}} 4.x, and {{eck}} 3.x can all be found on this site, as well as all unversioned products, such as {{ech}} and {{serverless-full}}.
1010

11-
## Contribute to the docs [#contribute]
11+
This documentation is **cumulative**. This means that a new set of docs is not published for every minor release. Instead, each page stays valid over time and incorporates version-specific changes directly within the content.
1212

13-
In April 2025, we released our new documentation site. This site includes documentation for our latest product versions, including {{stack}} 9.0+ and {{serverless-full}}.
13+
[Learn how to write cumulative documentation](how-to/cumulative-docs/index.md).
1414

15-
:::{include} _snippets/two-systems.md
16-
:::
15+
## How to contribute
1716

18-
### Contribute elastic.co/docs
17+
- For **simple bug fixes and enhancements**: [Contribute on the web](on-the-web.md)
18+
- For **complex or multi-page updates**: [Contribute locally](locally.md)
1919

20-
:::{include} _snippets/docs-intro.md
21-
:::
22-
23-
* For **simple bug fixes and enhancements**: [Contribute on the web](on-the-web.md)
24-
* For **complex or multi-page updates**: [Contribute locally](locally.md)
25-
26-
#### Branches in V3
27-
28-
In Docs V3, a single branch is published per repository. This branch is set to `main` by default, but it is possible to instead publish a different branch by changing your repository's deployment model. You might want to change your deployment model so you can have more control over when content added for a specific release is published.
29-
30-
### Contribute to elastic.co/guide
20+
## Report a bug
3121

32-
For contributing to elastic.co/guide (legacy documentation), see [Contribute to legacy documentation](legacy-docs.md).
22+
- For **documentation** problems: [Open a docs issue](https://github.com/elastic/docs-content/issues/new?template=internal-request.yaml) *or* [Fix it myself](locally.md).
23+
- Elastic employees can open internal-only issues in our [internal repo](https://github.com/elastic/docs-content-internal/issues/new/choose).
24+
- For **build tool (docs-builder)** problems: [Open a bug report](https://github.com/elastic/docs-builder/issues/new?template=bug-report.yaml)
3325

34-
## Report a bug
26+
## Request an enhancement or docs for a new feature
3527

36-
* For **documentation** problems: [Open a docs issue](https://github.com/elastic/docs-content/issues/new?template=internal-request.yaml) *or* [Fix it myself](locally.md). You can open sensitive issues in our [internal repo](https://github.com/elastic/docs-content-internal/issues/new/choose).
37-
* For **build tool (docs-builder)** problems: [Open a bug report](https://github.com/elastic/docs-builder/issues/new?template=bug-report.yaml)
28+
- Make the **documentation** better: [Open a docs issue](https://github.com/elastic/docs-content/issues/new?template=internal-request.yaml).
29+
- Elastic employees can open internal-only issues in our [internal repo](https://github.com/elastic/docs-content-internal/issues/new/choose).
30+
- Make our **build tool (docs-builder)** better: [Start a docs-builder discussion](https://github.com/elastic/docs-builder/discussions)
3831

39-
## Request an enhancement or documentation for a new feature
32+
## Contribute to legacy docs
4033

41-
* Make the **documentation** better: [Open a docs issue](https://github.com/elastic/docs-content/issues/new?template=internal-request.yaml). Elastic employees can open sensitive issues in our [internal repo](https://github.com/elastic/docs-content-internal/issues/new/choose).
42-
* Make our **build tool (docs-builder)** better: [Start a docs-builder discussion](https://github.com/elastic/docs-builder/discussions)
34+
To contribute to [elastic.co/guide](https://www.elastic.co/guide) (legacy documentation), refer to [Contribute to legacy documentation](legacy-docs.md).

0 commit comments

Comments
 (0)