Skip to content

Commit cac1daa

Browse files
leemthompolcawl
andauthored
Fixes per Lisa's review
Co-authored-by: Lisa Cawley <[email protected]>
1 parent db5c053 commit cac1daa

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

contribute-docs/api-docs/kibana-api-docs-quickstart.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Edit the TypeScript route definitions in your plugin code. Add JSDoc comments, r
8989
9090
::::{tab-item} Manual YAML
9191
:sync: manual
92-
Edit the YAML files directly in the `oas_docs` directory. Refer to the README alongside each file for specific guidance on adding summaries, descriptions, tags, metadata, links, and examples.
92+
Edit the YAML files in the appropriate plugin or package directory. Refer to the README alongside each file for specific guidance on adding summaries, descriptions, tags, metadata, links, and examples.
9393
9494
Review the the [checklist](checklist.md) for best practices.
9595
@@ -158,7 +158,7 @@ const oasOperationObject = () => path.join(__dirname, 'foo.examples.yaml');
158158
})
159159
```
160160

161-
**For Manual YAML**, add examples directly in your YAML files in the `oas_docs` directory.
161+
**For manual YAML**, add examples directly in your YAML files in the appropriate plugin or package directory.
162162

163163
**Example YAML structure:**
164164

@@ -189,7 +189,7 @@ responses:
189189

190190
::::::
191191

192-
::::::{step} (optional) Capture OAS snapshot
192+
::::::{step} (optional) Capture code-generated output
193193

194194
:::::{tab-set}
195195
:group: kibana-workflow
@@ -234,17 +234,17 @@ This step is not applicable for Manual YAML. Your YAML files in the `oas_docs` d
234234
235235
::::{step} Generate docs
236236
237-
Run these commands to generate the merged OpenAPI documentation files:
237+
Run these commands to merge the OpenAPI documentation files:
238238
239239
```bash
240240
cd oas_docs
241241
make api-docs
242242
```
243243
244-
This generates the the following files:
244+
This generates the following files:
245245
246246
- `oas_docs/output/kibana.yaml`
247-
- `oas_docs/output/kibana.info.yaml`
247+
- `oas_docs/output/kibana.serverless.yaml`
248248
249249
:::{tip}
250250
Use `make help` to see available commands.

0 commit comments

Comments
 (0)