Skip to content

Commit dc41b61

Browse files
committed
Move Elasticsearch lint after overlay
1 parent d32f768 commit dc41b61

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

extend/contribute/api-docs/quickstart.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,15 @@ The `transform-to-openapi` command (run by `make contrib`) is used for client li
8383
:::
8484
::::
8585

86+
::::{step} Apply overlays
87+
88+
[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.
89+
90+
```shell
91+
make overlay-docs
92+
```
93+
::::
94+
8695
::::{step} Lint your docs
8796

8897
Run this command to lint your docs-specific OpenAPI files:
@@ -94,15 +103,6 @@ You should try to fix all linter warnings and not just errors. Fixing errors alo
94103
:::
95104
::::
96105

97-
::::{step} Apply overlays
98-
99-
[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.
100-
101-
```shell
102-
make overlay-docs
103-
```
104-
::::
105-
106106
::::{step} Preview your changes
107107
Generate a preview of how your docs will appear:
108108
```shell

0 commit comments

Comments
 (0)