Skip to content

Commit c1526cc

Browse files
committed
Adds links that point to the API contrib guidelines to repo docs.
1 parent 26fdeef commit c1526cc

File tree

5 files changed

+13
-3
lines changed

5 files changed

+13
-3
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,10 @@ An interactive viewer for the Elasticsearch specification is available
8383

8484
See [CONTRIBUTING.md](./CONTRIBUTING.md)
8585

86+
Refer to the
87+
[Contributie to Elastic API docs](https://www.elastic.co/docs/extend/contribute/api-docs/)
88+
for more details about the API documentation guidelines.
89+
8690
## Make Targets
8791

8892
```

docs/add-new-api.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ in this repository, or we do have an endpoint definition in [`/specification/_js
55
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

8+
Refer to the
9+
[API docs contribution guidelines](https://www.elastic.co/docs/extend/contribute/api-docs/)
10+
to learn more about how to craft great docs for your API.
11+
812
## How to add a new endpoint
913

1014
Add a new endpoint is straightforward, you only need to copy-paste the json rest-api-spec definition

docs/doc-comments-guide.md

Lines changed: 3 additions & 1 deletion
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 [API documentation guidelines](https://docs.elastic.dev/content-architecture/oas#summaries).
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.
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,6 +76,8 @@ 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.
80+
7981
### Terseness
8082

8183
**Doc comments are reference material**: they should be as succinct as possible while capturing all the necessary information to use the elements they're documenting. Remember that they will often show up in small IDE autocompletion popups!

docs/modeling-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ the basic types [here](https://www.typescriptlang.org/docs/handbook/basic-types.
99
while in [behaviors](./behaviors.md) you can find the list of special interfaces used
1010
for describing APIs that can't be represented in the specification.
1111

12-
Refer to the [documentation guide](doc-comments-guide.md) to add documentation to types and fields.
12+
Refer to the [API docs contribution guidelines](https://www.elastic.co/docs/extend/contribute/api-docs/) to add documentation to types and fields.
1313

1414
### Dictionary
1515

docs/schema-structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ the basic types [here](https://www.typescriptlang.org/docs/handbook/basic-types.
99
while in [behaviors](./behaviors.md) you can find the list of special interfaces used
1010
for describing APIs that can't be represented in the specification.
1111

12-
Refer to the [documentation guide](doc-comments-guide.md) to add documentation to types and fields,
12+
Refer to the [API docs contributon guidelines](https://www.elastic.co/docs/extend/contribute/api-docs/) to add documentation to types and fields,
1313
and to the [modeling guide](modeling-guide.md) to learn how to model the different types.
1414

1515
You can find the schema representing all APIs and types in the [output folder](output/schema/schema.json).

0 commit comments

Comments
 (0)