-
Notifications
You must be signed in to change notification settings - Fork 159
Closed
Labels
Team:DeveloperIssues owned by the Developer Docs TeamIssues owned by the Developer Docs Team
Description
Type of issue
I can't find what I'm looking for
What documentation page is affected
https://www.elastic.co/docs/reference/query-languages/esql/esql-commands
Description
Users are unable to easily find documentation for specific ES|QL commands, such as the ENRICH command, because:
- All commands are grouped on single, long pages: Source commands and Processing commands.
- The content is difficult to scan and search, especially for less commonly used commands.
- There is duplication between the ES|QL Commands overview page and subsequent Source commands and Processing commands pages.
Proposed solution
To improve discoverability, usability, and maintainability of ES|QL command documentation:
- Split command documentation into individual pages
- Each ES|QL command (e.g., FROM, WHERE, ENRICH, etc.) should have its own dedicated page.
- Pages should include:
- Syntax
- Parameters
- Examples
- Related commands (optional cross-links)
- Consolidate and deduplicate overview content
- Keep a concise overview of all commands on the main ES|QL commands page.
- Remove redundant content that appears both in the overview and on individual command pages.
- Update navigation and internal links
- Update the ES|QL left nav to list each individual command.
- Ensure all existing links to commands in the current long-form page are redirected or updated.
Metadata
Metadata
Assignees
Labels
Team:DeveloperIssues owned by the Developer Docs TeamIssues owned by the Developer Docs Team