Skip to content

docs: add ES|QL patterns to chart pages (#5446) - #7957

Open
florent-leborgne wants to merge 7 commits into
mainfrom
docs-issue-5446-esql-chart-patterns
Open

docs: add ES|QL patterns to chart pages (#5446)#7957
florent-leborgne wants to merge 7 commits into
mainfrom
docs-issue-5446-esql-chart-patterns

Conversation

@florent-leborgne

@florent-leborgne florent-leborgne commented Aug 13, 2026

Copy link
Copy Markdown
Member

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

  • Executed all 13 documented queries against an Elastic Cloud Serverless 9.6.0 deployment with the sample datasets installed. Every query returned the documented result shape and non-empty results.
  • Created, retrieved, and deleted temporary inline ES|QL panels through the Kibana Dashboard API. Twelve chart configurations round-tripped successfully.
  • The mosaic query and its vertical-axis configuration passed, but Serverless 9.6.0 silently omitted the panel when the ES|QL horizontal-axis (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.
  • Built the full docs set locally with docs-builder 1.38.0 (--skip-api --skip-cross-links) and inspected the generated HTML for the changed chart sections.
  • Vale reports no errors. Its warnings are pre-existing findings outside the changed lines.

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

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No

Tool and model used: OpenAI Codex (GPT-5).


AI-generated draft — created with OpenAI Codex.
Review all generated content for factual accuracy before merging.

AI-Assisted: OpenAI Codex
@github-actions

github-actions Bot commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check 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.

@github-actions

github-actions Bot commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

Elastic Docs Style Checker (Vale)

Summary: 2 warnings found

⚠️ Warnings (2): Fix when the suggestion improves clarity or correctness.
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.

@github-actions

Copy link
Copy Markdown
Contributor

Docs review summary

Focus areas

  • Style and clarity: Clean. New ES|QL sections follow the surrounding pattern (steps, chart-preview description, settings link). No new style-guide violations found in the diff.
  • Jargon: None. {{esql}}, chart-type names, and field names are used in context consistent with the rest of the page.
  • Frontmatter and applies_to: Unaffected by this PR; no frontmatter changes needed for the new content.
  • Content type fit: How-to structure preserved — each new "Build a X chart with {{esql}}" section mirrors the existing point-and-click section (prerequisites snippet, query, numbered steps, checkpoint sentence).
  • Contradictions: No contradictions found. Cross-checked DATE_EXTRACT usage in heat-map-charts.md against the published ES|QL DATE_EXTRACT reference — hour_of_day and day_of_week are valid ChronoField values. Verified all internal anchor links (#_create_from_dashboard, #<chart>-chart-settings) resolve to existing headings in the target files.
  • Parent issue satisfaction: Satisfied. All chart types listed in Add ES|QL query patterns to individual Lens chart type pages #5446 (metric, bar, line/area, pie, heatmap, table, tag cloud, gauge, plus mosaic/treemap/waffle/region map) now have an ES|QL pattern section, and esorql.md links back to the chart pages as requested.

Notes

  • The two pre-existing Vale warnings in esorql.md (etc on line 31, whether or not on line 154) are outside the changed hunk, consistent with the PR description; not flagged here.

Generated by Docs review agent for #7957 · sonnet50 · 93.1 AIC · ⌖ 3.86 AIC · ⊞ 17.1K ·

AI-Assisted: OpenAI Codex
AI-Assisted: OpenAI Codex
Comment thread explore-analyze/_snippets/esql-visualization-prerequisites.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add ES|QL query patterns to individual Lens chart type pages

1 participant