Skip to content

Commit 6fc27eb

Browse files
authored
Merge branch 'main' into eck-3.2.0
2 parents a52c931 + b250c9e commit 6fc27eb

File tree

652 files changed

+9155
-6625
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

652 files changed

+9155
-6625
lines changed

.github/CODEOWNERS

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,20 @@
99
# The docs
1010
/cloud-account/ @elastic/admin-docs
1111
/deploy-manage/ @elastic/admin-docs
12+
1213
/explore-analyze/ @elastic/core-docs @elastic/experience-docs
14+
/explore-analyze/alerts-cases/ @elastic/experience-docs
15+
/explore-analyze/dashboards/ @elastic/experience-docs
16+
/explore-analyze/discover/ @elastic/experience-docs
17+
/explore-analyze/elastic-inference/ @elastic/developer-docs @elastic/experience-docs
18+
/explore-analyze/find-and-organize/ @elastic/experience-docs
19+
/explore-analyze/machine-learning/ @elastic/developer-docs @elastic/experience-docs
20+
/explore-analyze/query-filter/ @elastic/developer-docs @elastic/experience-docs
21+
/explore-analyze/report-and-share/ @elastic/experience-docs
22+
/explore-analyze/scripting/ @elastic/admin-docs
23+
/explore-analyze/transforms/ @elastic/developer-docs
24+
/explore-analyze/visualize/ @elastic/experience-docs
25+
1326
/extend/ @elastic/core-docs
1427
/get-started/ @elastic/core-docs @elastic/project-docs
1528

@@ -64,7 +77,7 @@
6477
/troubleshoot/security/ @elastic/ski-docs
6578

6679
# Raw migrated files
67-
/raw-migrated-files/ @elastic/docs
80+
/raw-migrated-files/ @elastic/admin-docs
6881

6982
# Legacy serverless docs
7083
/serverless/ @elastic/admin-docs

cloud-account/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ applies_to:
99
products:
1010
- id: cloud-hosted
1111
- id: cloud-serverless
12+
description: Manage your Elastic Cloud account settings, including email, password,
13+
authentication methods, and personal preferences. Configure your user profile
14+
and customize your interface.
1215
---
1316

1417
# Manage your Cloud account and preferences

extend/contribute/api-docs/checklist.md renamed to contribute-docs/api-docs/checklist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Use this checklist to verify the quality, completeness, and consistency of your
2727

2828
## Quality assurance
2929

30-
- Preview your changes locally before submitting (see [Contribute locally: Elasticsearch quickstart](./quickstart.md))
30+
- Preview your changes locally before submitting (see [Quickstarts](./quickstart.md))
3131
- [Lint your API docs](guidelines.md#lint-your-api-docs) to identify and fix issues
3232
- Check all links to ensure they work correctly
3333
- Ensure examples are realistic and error-free

extend/contribute/api-docs/quickstart.md renamed to contribute-docs/api-docs/elasticsearch-api-docs-quickstart.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,29 @@
11
---
2-
navigation_title: Contribute locally (Elasticsearch)
2+
navigation_title: Elasticsearch API docs
33
---
44

5-
# Contribute locally: Elasticsearch quickstart
5+
# Contribute to Elasticsearch API docs locally
6+
7+
## Overview
68

79
The Elasticsearch APIs are the foundation of the Elastic Stack and the largest API set we maintain. Because the workflow is quite complex, we created this quickstart guide to help you get started.
810

911
This is a step-by-step local development workflow. While CI runs these steps automatically on PR branches in the `elasticsearch-specification` repo (see [Makefile](https://github.com/elastic/elasticsearch-specification/blob/main/Makefile)), working locally enables you to validate, preview and debug before submitting your changes. For a complete list of available make targets, run `make help`.
1012

1113
For the official Elasticsearch specification contribution guidance, see [`CONTRIBUTING.md`](https://github.com/elastic/elasticsearch-specification/blob/main/CONTRIBUTING.md#contributing-to-the-elasticsearch-specification).
1214

15+
## Quickstart
16+
17+
Follow these steps to contribute to Elasticsearch API docs locally:
18+
1319
:::::{stepper}
1420

1521
::::{step} Prepare your environment
1622

1723
Run this command to set up your Node.js environment:
1824

1925
```shell
20-
nvm use
26+
nvm use
2127
```
2228
If you don't have Node.js installed, refer to the [setup guide](https://github.com/elastic/elasticsearch-specification/tree/main?tab=readme-ov-file#prepare-the-environment).
2329
::::
@@ -78,6 +84,15 @@ The `transform-to-openapi` command (run by `make contrib`) is used for client li
7884
:::
7985
::::
8086

87+
::::{step} Apply overlays
88+
89+
[OpenAPI overlays](https://github.com/OAI/Overlay-Specification?tab=readme-ov-file#overlay-specification) are used to handle publisher-specific requirements or work around rendering limitations. For example, they sort the list of tags alphabetically and apply `x-model` extensions to abbreviate deeply nested/recursive schema objects.
90+
91+
```shell
92+
make overlay-docs
93+
```
94+
::::
95+
8196
::::{step} Lint your docs
8297

8398
Run this command to lint your docs-specific OpenAPI files:
@@ -89,14 +104,6 @@ You should try to fix all linter warnings and not just errors. Fixing errors alo
89104
:::
90105
::::
91106

92-
::::{step} Apply overlays
93-
94-
[OpenAPI overlays](https://github.com/OAI/Overlay-Specification?tab=readme-ov-file#overlay-specification) are used to handle publisher-specific requirements or work around rendering limitations. For example, they sort the list of tags alphabetically and apply `x-model` extensions to abbreviate deeply nested/recursive schema objects.
95-
96-
```shell
97-
make overlay-docs
98-
```
99-
100107
::::{step} Preview your changes
101108
Generate a preview of how your docs will appear:
102109
```shell
@@ -115,4 +122,4 @@ Once you're satisfied with your docs changes:
115122
3. Once approved, merge your changes and ensure they are backported to the appropriate branches
116123
::::
117124

118-
:::::
125+
:::::

extend/contribute/api-docs/guidelines.md renamed to contribute-docs/api-docs/guidelines.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -510,7 +510,7 @@ paths:
510510
:::{tab-item} Elasticsearch
511511
:sync: elasticsearch
512512

513-
**External documentation links** use the `@ext_doc_id` annotation to connect to narrative guides. This is transformed into an OpenAPI `externalDocs` field in the [compilation process](overview.md#example-elasticsearch):
513+
**External documentation links** use the `@ext_doc_id` annotation to connect to narrative guides. This is transformed into an OpenAPI `externalDocs` field in the [compilation process](./overview.md#example-elasticsearch):
514514

515515
```ts
516516
/**
@@ -621,7 +621,7 @@ The [Elasticsearch API specification](https://github.com/elastic/elasticsearch-s
621621
- **Spectral**: Configuration in `.spectral.yaml`
622622
- **Redocly**: Configuration in `redocly.yaml`
623623

624-
Refer to [the Elasticsearch quickstart](quickstart.md#lint-your-docs) to learn how to run the linter locally.
624+
Refer to [the quickstarts](quickstart.md) to learn how to run the linter locally.
625625

626626
::::
627627
::::

extend/contribute/api-docs/help.md renamed to contribute-docs/api-docs/help.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
The API docs workflow is pretty complicated, and there's lots of moving parts. It takes a village to produce excellent API docs, so don't hesitate to ask for help if you get stuck or have questions.
44

5-
If you're not sure who owns a specific API, check out the [API ownership table](workflows.md) to find the right team.
5+
If you're not sure who owns a specific API, check out the [API ownership table](./workflows.md) to find the right team.
66

77
## Report issues
88

99
### API docs issues
1010

1111
When you find a bug or gap in the API docs:
1212

13-
- If you're comfortable making the change, open a PR in the [relevant repo](workflows.md)
13+
- If you're comfortable making the change, open a PR in the [relevant repo](./workflows.md)
1414
- Alternatively, open an issue in either:
1515
- [elastic/docs-content](https://www.github.com/elastic/docs-content/issues) (public repo)
1616
- [elastic/docs-content-internal](https://www.github.com/elastic/docs-content-internal/issues) (Elastic employees only)

extend/contribute/api-docs/index.md renamed to contribute-docs/api-docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Learn how to contribute to Elastic's Open API docs across our various product re
1414

1515
4. [**Organize and annotate**](./organize-annotate.md) - Learn how to group your APIs using tags and how to signal lifecycle status, deployment-type availability, and required permissions.
1616

17-
5. [**Contribute locally: Elasticsearch**](./quickstart.md) - Follow a step-by-step guide to contribute to Elasticsearch API docs, including environment setup, local development workflow, and preview generation.
17+
5. [**Quickstarts: {{es}} and {{kib}}**](./quickstart.md) - Follow step-by-step guides to contribute to {{es}} and {{kib}} API docs, including environment setup, local development workflow, and preview generation.
1818

1919
6. [**Find your workflow**](./workflows.md) - Find the workflow for the specific Elastic API docs you're interested in and learn how the OpenAPI docs are generated, validated, and published.
2020

0 commit comments

Comments
 (0)