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
Copy file name to clipboardexpand all lines: docs/contribute/index.md
+94-2
Original file line number
Diff line number
Diff line change
@@ -10,17 +10,27 @@ Whether you're a technical writer or you've only edited Elastic docs once or twi
10
10
11
11
## Contribute to the docs [#contribute]
12
12
13
-
The version of the docs you want to contribute to determines the tool and syntax you must use to update the docs.
13
+
The version of the docs you want to contribute to determines the tool and syntax you must use to update the docs. The easiest way to find the source file for the page you want to update is to navigate to the page on the web and click **Edit this page**. This will take you to the source file in the correct repo.
14
14
15
15
### Contribute to Elastic Stack version 8.x docs and earlier
16
16
17
-
To contribute to earlier versions of the Elastic Stack, you must work with our [legacy documentation build system](https://github.com/elastic/docs). This system uses AsciiDoc as it's authoring format.
17
+
To contribute to earlier versions of the Elastic Stack, you must work with our [legacy documentation build system](https://github.com/elastic/docs). This system uses AsciiDoc as it's authoring format.
18
18
19
19
* For **simple bugfixes and enhancements** --> [Contribute on the web](on-the-web.md)
20
20
* For **complex or multi-page updates** --> See the [legacy documentation build guide](https://github.com/elastic/docs?tab=readme-ov-file#building-documentation)
21
21
22
+
If you need to update documentation for both 8.x and 9.x, you will have to work in two systems. See [What if I need to update both 8.x and 9.x docs?](https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/contribute/on-the-web#what-if-i-need-to-update-both-8.x-and-9.x-docs) for the processes on updating docs across different versions.
23
+
22
24
### Contribute to Elastic Stack version 9.0 docs and later
23
25
26
+
For all 9.0+ content, it lives in one of three spots:
27
+
28
+
1.**Reference/settings content** lives in the new Markdown files in the code repo as it did pre 9.0. This enables folks to make updates that touch code \+ low-level docs in the same PR.
29
+
2.**Narrative/conceptual and overview content** lives in [elastic/docs-content](https://github.com/elastic/docs-content). As an example the [ES|QL overview](https://docs-v3-preview.elastic.dev/elastic/docs-content/tree/main/explore-analyze/query-filter/languages/esql) lives in the **Explore & Analyze** section of the narrative docs. But the reference documentation lives in the reference section of the docs [ES|QL reference](https://docs-v3-preview.elastic.dev/elastic/elasticsearch/tree/main/reference/query-languages/esql)
30
+
3.**API reference docs** live in the different OpenAPI spec repositories. This is where you need to update API docs published in the new API docs system
31
+
32
+
When you are ready to edit the content:
33
+
24
34
* For **simple bugfixes and enhancements** --> [contribute on the web](on-the-web.md)
25
35
* For **complex or multi-page updates** --> [Contribute locally](locally.md)
26
36
@@ -37,3 +47,85 @@ To contribute to earlier versions of the Elastic Stack, you must work with our [
37
47
## Work on docs-builder
38
48
39
49
That sounds great! See [development](../development/index.md) to learn how to contribute to our documentation build system.
50
+
51
+
## Where does the content live
52
+
53
+
You can use the following sections to help you determine where the content you might want to work on lives.
54
+
55
+
### Kibana
56
+
57
+
#### What has moved to elastic/docs-content?
58
+
59
+
Public-facing narrative and conceptual docs have moved. Most can now be found under the following directories in the new docs:
60
+
61
+
* explore-analyze: Discover, Dashboards, Visualizations, Reporting, Alerting, dev tools...
62
+
* deploy-manage: Stack management (Spaces, user management, remote clusters...)
63
+
* troubleshooting: troubleshooting pages
64
+
65
+
#### What is staying in the Kibana repo?
66
+
67
+
* Reference content (= anything that is or could be auto-generated): Settings, syntax references, functions lists...
68
+
* Release notes
69
+
* Developer guide
70
+
71
+
### Elasticsearch
72
+
73
+
#### What has moved to elastic/docs-content?
74
+
75
+
Public-facing narrative and conceptual docs have moved. Most can now be found under the following directories in the new docs:
|**Get started**| Content in this section focuses on learning about Elasticsearch and the stack, learning about how it can be deployed, and basic environment setup for initial exploration. ||
124
+
|**Solutions and use cases**| Content in this section focuses on the core solutions themselves and their user cases. |**Search:** core search solution content, playground, hybrid search **Observability:** core observability content **Security:** core security content |
125
+
|**Manage data**| Content in this section focuses on learning about Elastic data store primitives, evaluating and implementing ingestion and data enrichment technologies, managing the lifecycle of your data and migrating data between clusters. |**Elasticsearch:** data store, migration, data lifecycle **Ingest:** ingesting data into Elasticsearch **Kibana**: Discover, Dashboards, Visualizations, Reporting, Alerting, dev tools. |
126
+
|**Explore and analyze**| Content in this section focusing on querying, visualizing, and exploring data. Additionally it focusing on leveraging machine learning for data analysis and defining and responding to alerts |**Elasticsearch:** query languages, scripting, machine learning (NLP) **Machine Learning:** Anomaly detection, data frame analytics, NLP **Kibana**: Discover, Dashboards, Visualizations, Reporting, Alerting, dev tools. **ResponseOps:** Alerts and Cases |
127
+
|**Deploy and manage**| Content in this section focuses on evaluating deployment options and setting your environment up. This section also contains content around managing, securing, and monitoring your cluster. |**Elasticsearch:** deploying elastic, production guidance, security, and Management |
128
+
|**Manage your Cloud account**| Content in this section focuses specifically on managing Cloud accounts. ||
129
+
|**Troubleshoot**| Content in this section is troubleshooting content for the different products as well as how to contact support. |**All troubleshooting content**|
130
+
|**Extend and contribute**| Content in this section focuses on contributing to Elastic products and building plugins, clients, and beats modules. |**Contributions guides for:** Kibana Logstash Beats **Developer guides for:** Integrations Elasticsearch Plugins |
131
+
|**Reference**| Content in this section focuses on manuals for optional products as well as reference materials like query language references, configuration references, etc. |**Elastic APIS Elastic Clients Query Languages APM Agents Kibana:** Reference content, Release notes, Developer guide |
0 commit comments