Skip to content

Break out ES|QL commands into single pages #2401

@KOTungseth

Description

@KOTungseth

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:

Proposed solution

To improve discoverability, usability, and maintainability of ES|QL command documentation:

  1. 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)
  1. 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.
  1. 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 Team

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions