Skip to content

Commit 2ca68a1

Browse files
authored
[9.0] [DOCS] Update API ref link in docs README (#124069) (#124216)
* [DOCS] Update API ref link in docs README (#124069) https://github.com/elastic/elasticsearch-specification/pull/3873/files (cherry picked from commit badfc93) # Conflicts: # docs/README.md * Fix README
1 parent 4fffe26 commit 2ca68a1

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Docs live in **three places**:
1717

1818
1. **Reference content** lives in this repo. This covers low-level stuff like settings and configuration information that is tightly coupled to code.
1919
- 👩🏽‍💻 **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)
2121
- 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/)
2222
- 👩🏽‍💻 **Engineers** own this content.
2323
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
4949

5050
> [!TIP]
5151
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.
5353

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

5656
> [!NOTE]
5757
> If you need to make changes to 9.x docs and 8.x docs, you'll need to use two different workflows:
5858
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.
6060
- **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.
6161

6262
## Test code snippets

0 commit comments

Comments
 (0)