Skip to content

Commit ba9eee8

Browse files
szabostevepquentin
andauthored
Apply suggestions from code review
Co-authored-by: Quentin Pradet <[email protected]>
1 parent cd07a26 commit ba9eee8

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This JSON representation is formally defined by [a set of TypeScript definitions
1919
that also explains the various properties and their values.
2020

2121
> [!TIP]
22-
> To learn more about how to write docs specifically for our [API references](https://www.elastic.co/docs/api/), refer to our [contribution guide](https://www.elastic.co/docs/extend/contribute/api-docs/).
22+
> To learn more about how to write docs specifically for our [API references](https://www.elastic.co/docs/api/), refer to the [Contribute to Elastic API docs](https://www.elastic.co/docs/extend/contribute/api-docs/).
2323
2424
## Prepare the environment
2525

docs/add-new-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ but we don't have a type definition for it.
66
In this document you will see how to add a new endpoint and how to add a new endpoint definition.
77

88
> [!TIP]
9-
> To learn more about how to write docs specifically for our [API references](https://www.elastic.co/docs/api/), refer to our [contribution guide](https://www.elastic.co/docs/extend/contribute/api-docs/).
9+
> To learn more about how to write docs specifically for our [API references](https://www.elastic.co/docs/api/), refer to the [Contribute to Elastic API docs](https://www.elastic.co/docs/extend/contribute/api-docs/).
1010
1111
## How to add a new endpoint
1212

docs/doc-comments-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ A specification is not only about formalizing data structures, it's also about e
55
Documentation of the TypeScript specification is made using [JSDoc](https://jsdoc.app/) comments, i.e. multiline comments starting with `/**` above a type or field declaration.
66

77
The first phrase is used as the mandatory operation summary in the OpenAPI document.
8-
Refer to the [API docs contribution guidelines](https://www.elastic.co/docs/extend/contribute/api-docs/guidelines) to learn more about how to create great documentation for your API.
8+
Refer to the [Elastic API docs contribution guidelines](https://www.elastic.co/docs/extend/contribute/api-docs/guidelines) to learn more about how to create great documentation for your API.
99

1010
> [!NOTE]
1111
> You must add a period at the end of the phrase for it to parse correctly. The period will be properly omitted from the output OpenAPI document.
@@ -76,7 +76,7 @@ GFM also has implementations in most languages, meaning that code generators wil
7676

7777
## Structuring a doc-comment
7878

79-
For guidelines of how to write great doc-comments, refer to the [Contribute to API docs](https://www.elastic.co/docs/extend/contribute/api-docs/guidelines#write-descriptions) page.
79+
For guidelines of how to write great doc-comments, refer to the [Contribute to Elastic API docs](https://www.elastic.co/docs/extend/contribute/api-docs/guidelines#write-descriptions) page.
8080

8181
### Terseness
8282

docs/schema-structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Refer to the [documentation guide](doc-comments-guide.md) to add documentation t
1313
and to the [modeling guide](modeling-guide.md) to learn how to model the different types.
1414

1515
> [!TIP]
16-
> To learn more about how to write docs specifically for our [API references](https://www.elastic.co/docs/api/), refer to our [contribution guide](https://www.elastic.co/docs/extend/contribute/api-docs/).
16+
> To learn more about how to write docs specifically for our [API references](https://www.elastic.co/docs/api/), refer to the [Contribute to Elastic API docs](https://www.elastic.co/docs/extend/contribute/api-docs/).
1717
1818
You can find the schema representing all APIs and types in the [output folder](output/schema/schema.json).
1919
The schema is structured as follows:

0 commit comments

Comments
 (0)