elastic / elastic/cli

[docs] Generated reference docs for ES helpers are incomplete

Open
#654 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
41
Forks
24
Avg merge
1d 3h
Merged PRs (30d)
56

Description

[Reference docs for ES helpers](https://www.elastic.co/docs/reference/elastic-cli/cli/stack/es/helpers) does not show the sub-commands we would expect to see: `scroll-search`, `bulk-ingest`, `msearch` and `watch`.

I presume this is due to them being generated incorrectly by `elastic cli-schema`.

Contributor guide

Open the contributing guide

Research direction

Start with the generated ES helpers reference page and inspect how `elastic cli-schema` produces it. Trace why `scroll-search`, `bulk-ingest`, `msearch`, and `watch` are omitted, then regenerate the reference docs and confirm all four sub-commands appear.

Written by the indexing model from the issue text.

Assessment

Tech stack
elasticsearch, typescript
Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.