Skip to content

docs: add visualization approach decision guidance & improve intros to balance both modes (#5447)#6560

Merged
florent-leborgne merged 12 commits into
mainfrom
docs-issue-5447-lens-vs-esql
May 25, 2026
Merged

docs: add visualization approach decision guidance & improve intros to balance both modes (#5447)#6560
florent-leborgne merged 12 commits into
mainfrom
docs-issue-5447-lens-vs-esql

Conversation

@florent-leborgne
Copy link
Copy Markdown
Member

@florent-leborgne florent-leborgne commented May 19, 2026

Closes #5447

Summary

Adds decision guidance for users choosing between Lens's point-and-click mode (data views) and ES|QL mode for building visualizations.

Rather than a comparison table, the guidance is placed where it's most useful: the introduction of the ES|QL visualizations page. Users landing on esorql.md now immediately see the scenarios where ES|QL mode shines, plus a reverse pointer to Lens for simpler cases.

Changes:

  • esorql.md: adds "particularly useful when" bullet list (cross-index queries, complex filtering, prototyping from Discover) + reverse pointer to Lens
  • lens.md: adds one-sentence pointer to ES|QL visualizations for complex/cross-index use cases; removes comparison section
  • visualize.md: removes comparison section added in earlier iteration (net zero change from original)

More work on bringing ES|QL/Query mode more naturally up in docs will be carried as it also becomes more prominent an integrated over time in the UI

Checklist

  • Content verified against source: claims derived from kibana-dashboards skill and Kibana API (data_view_reference vs esql usage patterns)
  • Terminology aligned with Kibana UI ("point-and-click mode" per i18n strings in kibana#264457)
  • No removed pages → no redirects needed

Co-authored-by: Cursor <cursoragent@cursor.com>
@github-actions
Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

  • Review docs changes (docs-review). Status: not started.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 19, 2026

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 19, 2026

✅ Vale Linting Results

No issues found on modified lines!


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.

Both approaches are Lens — one uses drag-and-drop with data views,
the other uses ES|QL queries. Update section heading, intro, anchor,
and cross-references accordingly.

Co-authored-by: Cursor <cursoragent@cursor.com>
@florent-leborgne florent-leborgne changed the title docs: add decision guidance for Lens vs ES|QL visualizations (#5447) docs: add visualization approach decision guidance (#5447) May 22, 2026
florent-leborgne and others added 5 commits May 22, 2026 15:14
Co-authored-by: Cursor <cursoragent@cursor.com>
Primary section now lives on the Lens page where the decision
is most relevant. Replaced use-case rows with a strengths matrix
using checkmarks. visualize.md keeps a one-line pointer.

Co-authored-by: Cursor <cursoragent@cursor.com>
Rather than a comparison table on lens.md, add a short "particularly
useful when" list directly on the ES|QL visualizations page. Users
landing on esorql.md now immediately see the scenarios where it shines,
with a reverse pointer to Lens for simpler aggregations. Also adds a
one-sentence pointer in lens.md and removes the dedicated comparison
section from both lens.md and visualize.md.

Co-authored-by: Cursor <cursoragent@cursor.com>
Reorder the esorql.md intro so the page opens with the "particularly
useful when" context before the how-to entry points — easier to scan
for users evaluating whether ES|QL mode is right for them. Also tighten
the Lens back-reference to "Lens in point-and-click mode" and remove a
spurious trailing blank line from visualize.md.

Co-authored-by: Cursor <cursoragent@cursor.com>
Update "drag-and-drop" to "point-and-click" in the Lens page opening
line, aligning with new Kibana UI language (kibana#264457). Separate
the ES|QL cross-reference into its own paragraph so it's visible to
users skimming the intro rather than buried at the end of a sentence.
Also adds "prototyping from Discover" as a third trigger scenario for
the ES|QL pointer, consistent with esorql.md.

Co-authored-by: Cursor <cursoragent@cursor.com>
Comment thread explore-analyze/visualize/esorql.md Outdated
Comment thread explore-analyze/visualize/esorql.md Outdated
florent-leborgne and others added 2 commits May 22, 2026 17:00
Co-authored-by: Florent LB <florent.leborgne@elastic.co>
Co-authored-by: Cursor <cursoragent@cursor.com>
@florent-leborgne florent-leborgne marked this pull request as ready for review May 22, 2026 15:02
@florent-leborgne florent-leborgne requested review from a team as code owners May 22, 2026 15:02
Replace the existing intro paragraphs with a concise two-bullet
structure that names and describes both modes: point-and-click
(data view, no query required) and query (ES|QL or PromQL, for
complex and cross-index use cases). Data view setup info moves
into the point-and-click bullet. The query bullet links both
ES|QL and PromQL docs and points to esorql.md for details.

Co-authored-by: Cursor <cursoragent@cursor.com>
@florent-leborgne florent-leborgne changed the title docs: add visualization approach decision guidance (#5447) docs: add visualization approach decision guidance & improve intros to balance both modes (#5447) May 22, 2026
Copy link
Copy Markdown
Member

@nastasha-solomon nastasha-solomon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

Comment thread explore-analyze/visualize/lens.md Outdated
Comment thread explore-analyze/visualize/lens.md Outdated
- **Point-and-click**: configure your visualization interactively by selecting fields from a [data view](/explore-analyze/find-and-organize/data-views.md), choosing aggregations, and setting dimensions and display options. No query writing required. Data views are created automatically when you [upload a file](/manage-data/ingest/upload-data-files.md) or [add sample data](/manage-data/ingest/sample-data.md); otherwise, you need to create one manually.
- **Query**: write an [{{esql}}](elasticsearch://reference/query-languages/esql.md) or [PromQL](elasticsearch://reference/query-languages/esql/commands/promql.md) query to retrieve and transform your data, then configure the visualization on top of the result. Best suited for cross-index queries, complex filtering, and custom calculations. Refer to [ES|QL visualizations](esorql.md) for details.

:::{agent-skill}
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Outside the scope of this PR, but sharing in case it's worth considering: Since this skill helps users build the visualizations described in the following table, it might be more appropriate to place it after the table instead of before it. Up to you!

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good point 🤔


# ES|QL visualizations [esql-visualizations]

Creating visualizations using an {{esql}} query is particularly useful when you need to:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is nice.

florent-leborgne and others added 2 commits May 25, 2026 10:44
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
@florent-leborgne florent-leborgne enabled auto-merge (squash) May 25, 2026 08:45
@florent-leborgne florent-leborgne merged commit c85dbb2 into main May 25, 2026
7 checks passed
@florent-leborgne florent-leborgne deleted the docs-issue-5447-lens-vs-esql branch May 25, 2026 08:46
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 decision guidance: ES|QL vs. data views for visualizations

2 participants