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/README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ Docs live in **three places**:
17
17
18
18
1.**Reference content** lives in this repo. This covers low-level stuff like settings and configuration information that is tightly coupled to code.
19
19
- 👩🏽💻 **Engineers** own the bulk of this content.
20
-
2.**API reference docs** live in the [Elasticsearch specification](https://github.com/elastic/elasticsearch-specification)
20
+
2.**API reference docs** live in the [Elasticsearch specification](https://github.com/elastic/elasticsearch-specification/blob/main/README.md#how-to-generate-the-openapi-representation)
21
21
- This is where you need to update API docs published in the [new API docs system](https://www.elastic.co/docs/api/doc/elasticsearch/v8/)
22
22
- 👩🏽💻 **Engineers** own this content.
23
23
3.**Narrative, overview, and conceptual content** mostly lives in the [`docs-content`](https://github.com/elastic/docs-content/) repo.
@@ -49,14 +49,14 @@ To re-run CI checks, an Elastic employee can select the `Re-run this job` option
49
49
50
50
> [!TIP]
51
51
As of 9.0.0, we are currently only publishing from the `main` branch.
52
-
**This means that backporting is currently not necessary for 9.0+ Elasticsearch docs.**
52
+
We will continue to backport changes as usual, in case we need to revisit this approach in the future.
53
53
54
-
However, if you need to update the `8.x` docs, you'll have to use the old `asciidoc` system. Refer to the [`8.x` README](https://github.com/elastic/elasticsearch/blob/8.x/docs/README.asciidoc) for more information.
54
+
If you need to update the `8.x` docs, you'll have to use the old `asciidoc` system. Refer to the [`8.x` README](https://github.com/elastic/elasticsearch/blob/8.x/docs/README.asciidoc) for more information.
55
55
56
56
> [!NOTE]
57
57
> If you need to make changes to 9.x docs and 8.x docs, you'll need to use two different workflows:
58
58
59
-
-**For `9.x` docs**, create a PR using the new Markdown system against the `main` branch.
59
+
-**For `9.x` docs**, create a PR using the new Markdown system against the `main` branch and backport as necessary.
60
60
-**For `8.x` docs**, create a PR using the old AsciiDoc system against the `8.x` branch and backport the changes to any other `8.x` branches needed.
0 commit comments