Repository navigation
docs: restructure Discover around goals, with mode hubs and task pages (#4898) - #9014
florent-leborgne wants to merge 11 commits into
Conversation
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. |
0b25765 to
36cf5fd
Compare
2a8b2ab to
96c351d
Compare
fc66d3a to
97ac746
Compare
Docs review summaryIssue satisfactionPartially assessed. The PR is part of #4898 and covers the Discover restructure it describes. This was a sampled pass over a 45-file, 87-commit change, not an exhaustive review of every page. Review coverage
|
|
Thoughts in no particular order: I'm left wondering why I would want to use one mode or the other. The changes do a great job explaining what each mode is and how it works, but I'm never told when I'd pick one over the other. The ESQL tut is the closest feedback on this topic by saying that I can directly query by name without needing to create a data view first. But then six pages in The "Where to start" section doesn't really offer a classic getting started guide. Only ESQL. I presume that is by design? The flow from How it works --> Switch Query mode --> Explore your data makes sense. However, there are three pages in the Explore your data that don't support ES|QL mode while every other page does. It's the last three pages (maybe by design?). But I'm wondering if there's something more we can do here. Are there alternatives to, for example, running a pattern analysis that can be done in ESQL mode? Or is it practical enough to expect a user to switch modes if they want to achieve this? Manage your view and sessions is kind of a catch all. Settings, tabs, queries, sessions, alert rules. I like the "Save and share your explorations" title that you use on the hub page better. You could use that heading and move the customization and tab stuff to a "Set up your workspace" group. |
7d16ae0 to
f1fc79b
Compare
|
ty @bmorelli25, i was thinking about some of these and made a few more changes (minimal) that should address the issues. Some of these are by design indeed. |
f1fc79b to
b95a45a
Compare
b95a45a to
e3597b8
Compare
alexmarhaba
left a comment
There was a problem hiding this comment.
LGTM, amazing work @florent-leborgne, thank you!
950dd41 to
788beb9
Compare
…view (#8975) (#9253) ## Summary This PR is part of #4898 and is stacked on #9014. It targets the #9014 branch until that PR merges. It addresses #8975 with the following changes: - **`solutions/security/investigate/discover-security.md`**: The **Access the Security Discover experience** section said the Security experience activates only from the Security solution view. It now also covers Classic solution view spaces from 9.6: which data views and queries trigger it, that mixed data keeps the default experience, and how to turn it off. - **`solutions/observability/logs/discover-logs.md`**: Adds a section that lists the integrations that get the logs experience in the Classic solution view, and what keeps the default experience. The note about the Observability solution view points to it. - **`explore-analyze/discover/discover-get-started.md`**: The Observability, Security, and Classic solution view lists in **Context-aware experiences** are now one table of where you open **Discover** against the experiences you get. It adds the Classic solution view and the Elasticsearch solution view and projects. Numbered notes under the table hold the conditions that the cells link to. The new **Contextual profiles in Classic navigation** reference entry was added in elastic/kibana#303878, and the pages here link to it. ## Resolves Closes #8975 ## Differences from the issue - The issue suggested listing the exact Security index patterns. This PR describes the data in plain words, such as alerts and endpoint events, because the list is long and changes with the product. - The issue did not list the logs page. This PR adds the integration list there, because its note said the Observability solution view was required for a contextual logs experience. ## Generative AI disclosure 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [x] Yes - [ ] No Tool(s) and model(s) used: Claude Code with Claude Sonnet 5.5. I checked the claims against the Kibana source. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Sonnet 5.5 <noreply@anthropic.com>
…r works page (#4898) Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…4898) Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…ld analysis (#4898) Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…ng, and tab pages (#4898) Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…scover pages (#4898) Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…lution view (#4898) Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
… setting controls (#4898) Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…view (#8975) (#9253) ## Summary This PR is part of #4898 and is stacked on #9014. It targets the #9014 branch until that PR merges. It addresses #8975 with the following changes: - **`solutions/security/investigate/discover-security.md`**: The **Access the Security Discover experience** section said the Security experience activates only from the Security solution view. It now also covers Classic solution view spaces from 9.6: which data views and queries trigger it, that mixed data keeps the default experience, and how to turn it off. - **`solutions/observability/logs/discover-logs.md`**: Adds a section that lists the integrations that get the logs experience in the Classic solution view, and what keeps the default experience. The note about the Observability solution view points to it. - **`explore-analyze/discover/discover-get-started.md`**: The Observability, Security, and Classic solution view lists in **Context-aware experiences** are now one table of where you open **Discover** against the experiences you get. It adds the Classic solution view and the Elasticsearch solution view and projects. Numbered notes under the table hold the conditions that the cells link to. The new **Contextual profiles in Classic navigation** reference entry was added in elastic/kibana#303878, and the pages here link to it. ## Resolves Closes #8975 ## Differences from the issue - The issue suggested listing the exact Security index patterns. This PR describes the data in plain words, such as alerts and endpoint events, because the list is long and changes with the product. - The issue did not list the logs page. This PR adds the integration list there, because its note said the Observability solution view was required for a contextual logs experience. ## Generative AI disclosure 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [x] Yes - [ ] No Tool(s) and model(s) used: Claude Code with Claude Sonnet 5.5. I checked the claims against the Kibana source. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Sonnet 5.5 <noreply@anthropic.com>
bf01275 to
666ef88
Compare
| You can also ask the agent for follow-up analyses, including correlations between fields, time-over-time comparisons, and field statistics for specific columns. | ||
|
|
||
| {applies_to}`stack: preview 9.6+` {applies_to}`serverless: preview` To see the current documents without leaving the conversation, ask the agent to show them in an interactive **Discover** table. Refer to [Discover tables in chat](../ai-features/agent-builder/agent-builder-discover-tables.md). | ||
| ## Context-aware experiences [context-aware-discover] |
There was a problem hiding this comment.
Hey there @sddonne, could you check whether this section is ok? I had a chat earlier with @alexmarhaba regarding the changes done in elastic/kibana#296406
Alex mentioned that for logs, this would only work with certain integrations. These are listed directly in the discover-logs page that lives in the discover docs (also in this PR if you want to check, i'll tag you there too)
There was a problem hiding this comment.
(sorry it's a huge PR that restructures some other things but some changes are already stacked and I did want to draft them quickly after chatting with alex about the udpated structure)
|
|
||
| Once you have the logs you want to focus on, you can drill down further. For more on filtering, refer to [Filter logs in Discover](/solutions/observability/logs/filter-aggregate-logs.md#logs-filter-discover). | ||
|
|
||
| ### Use the logs experience in the Classic solution view [logs-classic-solution-view] |
There was a problem hiding this comment.
cc @sddonne and @alexmarhaba for the logs in classic view case, if you want to check this section.
…4898) The Metrics and Traces pages carry their own lifecycle tags. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
bmorelli25
left a comment
There was a problem hiding this comment.
Thanks for adding the mode guidance and classic vs ES|QL alternatives when the exist. Really nice improvements here. High level looks good. Let me know if you want me to dig into the details more.

Summary
This PR is part of #4898. It restructures the Discover docs around what readers want to do. The 525-line "Explore fields and data with Discover" tutorial becomes a "How Discover works" page, and its other content moves to pages that each do one job. Each query mode gets a short hub about how to query in that mode, and the remaining pages are grouped by job under two new parent pages. The Discover page becomes a hub that points readers to the right page. It targets the #9013 branch until that PR merges. This change supports several elements:
The navigation under Discover now looks like this with this PR:
Hub and foundations
explore-analyze/discover.md: now a hub. A "Where to start" list points to the foundations page and the first-query tutorial. Four goal groups follow: query your data, understand your data, shape what your queries return and show, and save and share your explorations. Tasks that work in only one mode name it.explore-analyze/discover/discover-get-started.mdalso gains a short tip in the query modes section that recommends ES|QL mode and says why. The hub's "Where to start" list adds a starting point for classic mode.explore-analyze/discover/discover-get-started.md: now "How Discover works" (overview, same URL). It explains what you see on screen, the two query modes, the context-aware experiences by where you open Discover from, the ways to save, share, and export what you find, and how you can arrive with a query already set from a dashboard panel or a shared link. The default mode for each version now lives inswitch-esql-mode.md.Mode hubs and mode-only pages
use-esql.mdanduse-classic-mode.md: retitled "How to query in Discover's ES|QL mode" and "How to query in Discover's classic mode". Each introduces its mode and links the pages about writing and refining queries in it.search-and-filter-classic.md,add-fields-to-data-views.md,visualize-field.md,show-field-statistics.md, andrun-pattern-analysis-discover.mdstate in Before you begin that Discover must be in classic mode.search-and-filter-classic.mdalso holds the steps to select a data view and a time range.inspect-grouped-stats.md,detect-change-points.md, andanalyze-discover-data-with-ai.mdstate in Before you begin that Discover must be in ES|QL mode.Two new parent pages
explore-data.md: "Explore your data in Discover". It lists the pages about understanding results and marks the ones that work in only one mode.manage-discover.md: "Manage your Discover view and sessions". It lists the pages under two headings: setting up your workspace, and saving and sharing your explorations.Pages moved from the tutorial, or new
explore-fields.md,inspect-documents.md,compare-documents.md,copy-and-share-documents.md,work-with-tabs.md,generate-alerts-from-discover.md,analyze-discover-data-with-ai.md,search-and-filter-classic.md,add-fields-to-data-views.md,visualize-field.md: split out of the tutorial.inspect-documents.md: also holds the classic-only actions to open a document on its own page or see the documents around it.explore-fields.md: adds the Add breakdown action, which splits the chart by a field.discover-search-for-relevance.md: has synced tabs for ES|QL mode and classic mode, with an ES|QL example.add-fields-to-data-views.md: lists every option of the runtime field editor and the supported field types.troubleshoot/kibana/discover-empty-fields.md: the empty fields FAQ from the tutorial, as a troubleshooting page.explore-analyze/_snippets/discover-cancel-query.md: the cancel-query text that applies to every query type, included inesql-results.mdandsearch-and-filter-classic.md.esql-results.mdalso gets the partial results note.Saved sessions
save-open-search.mdis split into three pages. It keeps saving and duplicating, and gains a section about opening and finding saved sessions.export-discover-session.md(new) holds the CSV and JSON exports.use-sessions-in-dashboards.md(new) holds the dashboard flows. The moved text is unchanged except for corrections to the privileges, the serverless CSV limits, and the UI labels and entry points in the dashboard flows.Accuracy corrections
?and??prefixes.esql-variable-controls.md,visualize/add-variable-controls.md, andquery-filter/languages/esql-kibana.mdinclude it.export-discover-session.md, and the matching steps inreport-and-share.mdandautomating-report-generation.md, describe the export action and the names it has in each version, including the More menu.applies_totags:MV_INTERSECTS, theTS_INFOandMETRICS_INFOexclusion for grouped results, creating an alerting v2 rule from Discover, and Hide null fields in classic mode.discover-get-started.md.inspect-documents.mdcovers documents and requests.EVALsection on the ES|QL results page, with one-line tips that point to it from the runtime field page, a pointer from the Sample size section to theLIMITcommand in ES|QL mode, the Discover export page as the target of the hub's export link, a one-line tip that points to ES|QL grouping on the pattern analysis page, and a sentence on what a link recipient sees in the share section. Plain-language replacements for internal terms, a few links between related pages, and a version-grouped list ofTSandLIMITbehavior onswitch-esql-mode.mdare also included.Titles and structure
save-open-search.mdalready covers it in full.day_of_weekpopover.visualize-field.mduses the image directive.Navigation and links
redirects.yml,explore-analyze/toc.yml,troubleshoot/toc.yml, and inbound links: every moved anchor has a redirect, and links in this repository point straight to the new pages. Link text that used the old page titles is updated.Generative AI disclosure
Tool(s) and model(s) used: Claude Code with Claude Sonnet 5.5. I moved existing text without rewriting it where possible. The hubs, the "How Discover works" page, the two parent pages, and the relevance tabs are new prose. I checked their claims, and the privileges, labels, and limits on the session pages, against the existing pages and the Kibana source.
🤖 Generated with Claude Code