docs: add ES|QL patterns to chart pages (#5446) - #7957
Open
florent-leborgne wants to merge 7 commits into
Open
Conversation
AI-Assisted: OpenAI Codex
Contributor
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
Contributor
Contributor
Elastic Docs Style Checker (Vale)Summary: 2 warnings found
|
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/visualize/charts/gauge-charts.md | 75 | Elastic.Spelling | 'inin' is a possible misspelling. |
| explore-analyze/visualize/charts/metric-charts.md | 78 | Elastic.Spelling | 'inin' is a possible misspelling. |
The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.
AI-Assisted: OpenAI Codex
Contributor
Docs review summaryFocus areas
Notes
|
AI-Assisted: OpenAI Codex
AI-Assisted: OpenAI Codex
florent-leborgne
marked this pull request as ready for review
August 14, 2026 17:27
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR addresses #5446 with the following changes:
explore-analyze/visualize/charts/*.md: Adds a concise method chooser to all 13 chart pages, presents point-and-click and ES|QL query-based workflows as sibling options, and moves shared best practices after both procedures. The ES|QL H2 titles explicitly name an ES|QL query for search and UI alignment. The ES|QL sections include runnable query patterns, explain why each result shape fits the chart, map result columns to dimensions, and provide success checkpoints.explore-analyze/_snippets/esql-visualization-prerequisites.md: Adds reusable ES|QL visualization requirements, introduces result columns as chart dimensions, and links to the central query-mode workflow.explore-analyze/_snippets/lens-prerequisites.md: Refocuses the existing prerequisite on the point-and-click editor and its data-view requirement.explore-analyze/visualize/esorql.md: Explains how grouping, time-bucket, and numeric metric columns map to common chart dimensions, names ES|QL queries in the chart-types section title, and adds reciprocal navigation to the chart-specific ES|QL patterns.Validation
group_breakdown_by) configuration was included. Current Kibana source declares that configuration supported, so this appears to be a Dashboard API-specific limitation rather than a query or UI documentation issue. No temporary dashboards remain.--skip-api --skip-cross-links) and inspected the generated HTML for the changed chart sections.Screenshots to add or update
None. This change adds text guidance and query examples without changing the documented UI.
Resolves
Closes #5446
Generative AI disclosure
Tool and model used: OpenAI Codex (GPT-5).