Skip to content

Commit 80c583d

Browse files
authored
Merge branch 'main' into mw-tsds-final-countdown
2 parents 3fc8503 + 010d22d commit 80c583d

File tree

212 files changed

+1608
-654
lines changed

Some content is hidden

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

212 files changed

+1608
-654
lines changed

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
@@ -28,6 +28,6 @@ Use this checklist to verify the quality, completeness, and consistency of your
2828
## Quality assurance
2929

3030
- Preview your changes locally before submitting (see [Contribute locally: Elasticsearch quickstart](./quickstart.md))
31-
- [Lint your API docs](guidelines.md#lint-your-api-docs) to identify and fix issues
31+
- [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/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 Elasticsearch quickstart](./quickstart.md#lint-your-docs) 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)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
This page explains at a high-level how API docs work at Elastic today, with context on how this differs from our previous approaches and where we're heading. Use this page to understand the core primitives and workflows that apply across all Elastic teams, so you can contribute effectively.
44

55
:::{tip}
6-
The API docs use a different system to the main Elastic docs. Refer to [Contribute to Elastic docs](../../contribute/index.md) for an overview of the two systems.
6+
The API docs use a different system to the main Elastic docs. Refer to [Contribute to Elastic docs](../index.md) for an overview of the two systems.
77
:::
88

9-
While the implementation details [vary significantly across teams](workflows.md), at a high level:
9+
While the implementation details [vary significantly across teams](./workflows.md), at a high level:
1010

1111
- We use [OpenAPI](https://spec.openapis.org/oas/latest.html) files to generate REST API documentation
1212
- Our API docs are hosted by [Bump.sh](https://bump.sh/)
File renamed without changes.

0 commit comments

Comments
 (0)