[Discover] Rename Saved Search to Discover Session (#202217)

- Closes #174144 ## Summary This PR renames Saved Search into Discover Session in UI. - [x] Discover - [x] Saved Objects page and modal - [x] Docs - [x] Other occurrences <img width="810" alt="Screenshot 2024-12-16 at 15 20 10" src="https://github.com/user-attachments/assets/e39083da-f496-4ed5-bbdc-8e184897fc41" /> <img width="1220" alt="Screenshot 2024-12-11 at 14 40 15" src="https://github.com/user-attachments/assets/a6dc3e29-e1a5-4304-8148-0108231cc9de" /> <img width="1476" alt="Screenshot 2024-12-16 at 14 57 39" src="https://github.com/user-attachments/assets/4b34c70e-e21a-4d82-85f2-f5a3cb7a3826" /> ### Checklist - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [x] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: wajihaparvez <[email protected]> Co-authored-by: Davis McPhee <[email protected]> Co-authored-by: Julia Bardi <[email protected]>
elastic · Dec 18, 2024 · 40c9055 · 40c9055
1 parent ecd4567
commit 40c9055
Show file tree

Hide file tree

Showing 97 changed files with 214 additions and 425 deletions.
diff --git a/dev_docs/key_concepts/building_blocks.mdx b/dev_docs/key_concepts/building_blocks.mdx
@@ -42,7 +42,7 @@ and <DocLink id="kibBuildingBlocks" section="index-patterns" text="Index Pattern
 ### Dashboard Embeddable
 
 Add a Dashboard Embeddable directly inside your application to provide users with a set of visualizations and graphs that work seamlessly
-with the <DocLink id="kibBuildingBlocks" section="query-bar" text="Query Bar"/>. Every feature that is added to a registered <DocLink id="kibBuildingBlocks" section="embeddables" text="Embeddable" /> (Lens, Maps, Saved Searches and more) will be available automatically, as well as any <DocLink id="kibBuildingBlocks" section="ui-actions--triggers" text="UI Actions" /> that are added to the Embeddable context menu panel (for example, drilldowns, custom panel time ranges, and "share to" features).
+with the <DocLink id="kibBuildingBlocks" section="query-bar" text="Query Bar"/>. Every feature that is added to a registered <DocLink id="kibBuildingBlocks" section="embeddables" text="Embeddable" /> (Lens, Maps, Discover sessions and more) will be available automatically, as well as any <DocLink id="kibBuildingBlocks" section="ui-actions--triggers" text="UI Actions" /> that are added to the Embeddable context menu panel (for example, drilldowns, custom panel time ranges, and "share to" features).
 
 The Dashboard Embeddable is one of the highest-level UI components you can add to your application.
 

diff --git a/docs/concepts/data-views.asciidoc b/docs/concepts/data-views.asciidoc
@@ -166,7 +166,7 @@ clusters or indicies from cross-cluster search].
 When you delete a {data-source}, you cannot recover the associated field formatters, runtime fields, source filters,
 and field popularity data. Deleting a {data-source} does not remove any indices or data documents from {es}.
 
-WARNING: Deleting a {data-source} breaks all visualizations, saved searches, and other saved objects that reference the data view.
+WARNING: Deleting a {data-source} breaks all visualizations, saved Discover sessions, and other saved objects that reference the data view.
 
 . Go to the **Data Views** management page using the navigation menu or the <<kibana-navigation-search,global search field>>.
 

diff --git a/docs/concepts/esql.asciidoc b/docs/concepts/esql.asciidoc
@@ -26,7 +26,7 @@ disabled using the `enableESQL` setting from the
 {kibana-ref}/advanced-options.html[Advanced Settings].
 
 This will hide the {esql} user interface from various applications.
-However, users will be able to access existing {esql} artifacts like saved searches and visualizations.
+However, users will be able to access existing {esql} artifacts like saved Discover sessions and visualizations.
 ====
 
 [float]

diff --git a/docs/concepts/save-query.asciidoc b/docs/concepts/save-query.asciidoc
@@ -11,10 +11,10 @@ Save this query, and you can embed the search results in dashboards,
 use them as a foundation for building a visualization,
 and share them in a link or CVS form.
 
-Saved queries are different than <<save-open-search,saved searches>>,
+Saved queries are different than <<save-open-search,saved Discover sessions>>,
 which include the *Discover* configuration&mdash;selected columns in the document table, sort order, and
 {data-source}&mdash;in addition to the query.
-Saved searches are primarily used for adding search results to a dashboard.
+Discover sessions are primarily used for adding search results to a dashboard.
 
 [role="xpack"]
 ==== Read-only access

diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc
@@ -309,6 +309,7 @@ oss plugins.
 
 |{kib-repo}blob/{branch}/src/plugins/saved_search/README.md[savedSearch]
 |Contains the saved search saved object definition and helpers.
+This object is created when a user saves their current session in the Discover app.
 
 
 |{kib-repo}blob/{branch}/src/plugins/screenshot_mode/README.md[screenshotMode]

diff --git a/docs/discover/document-explorer.asciidoc b/docs/discover/document-explorer.asciidoc
@@ -36,7 +36,7 @@ In the pop-up, drag the column names to their new order.
 
 * To resize a column, drag the right edge of the column header until the column is the width that you want.
 +
-Column widths are stored with a saved search.  When you visualize saved searches on dashboards, the saved search appears the same as in **Discover**.
+Column widths are stored with a Discover session. When you add a Discover session as a dashboard panel, it appears the same as in **Discover**.
 
 [float]
 [[document-explorer-density]]

diff --git a/docs/discover/get-started-discover.asciidoc b/docs/discover/get-started-discover.asciidoc
@@ -293,24 +293,24 @@ Learn more about how to use ES|QL queries in <<try-esql, Using ES|QL>>.
 
 [float]
 [[save-discover-search]]
-==== Save your search for later use
+==== Save your Discover session for later use
 
-Save your search so you can use it later, generate a CSV report, or use it to create visualizations, dashboards, and Canvas workpads.
-Saving a search saves the query text, filters,
+Save your Discover session so you can use it later, generate a CSV report, or use it to create visualizations, dashboards, and Canvas workpads.
+Saving a Discover session saves the query text, filters,
 and current view of *Discover*, including the columns selected in
 the document table, the sort order, and the {data-source}.
 
 . In the application menu bar, click **Save**.
 
-. Give your search a title and a description.
+. Give your session a title and a description.
 
-. Optionally store <<managing-tags,tags>> and the time range with the search.
+. Optionally store <<managing-tags,tags>> and the time range with the session.
 
 . Click **Save**.
 
 [float]
 [[share-your-findings]]
-==== Share your search
+==== Share your Discover session
 
 To share your search and **Discover** view with a larger audience, click *Share* in the application menu bar.
 For detailed information about the sharing options, refer to <<reporting-getting-started,Reporting>>.

diff --git a/docs/discover/save-search.asciidoc b/docs/discover/save-search.asciidoc
@@ -1,9 +1,9 @@
 [[save-open-search]]
-== Save a search for reuse
+== Save a Discover session for reuse
 
-A saved search is a convenient way to reuse a search
+A saved Discover session is a convenient way to reuse a search
 that you've created in *Discover*.
-Saved searches are good for adding search results to a dashboard,
+Discover sessions are good for saving a configured view of Discover to use later or adding search results to a dashboard,
 and can also serve as a foundation for building visualizations.
 
 [role="xpack"]
@@ -16,27 +16,27 @@ displayed and the *Save* button is not visible. For more information, refer to <
 [role="screenshot"]
 image::discover/images/read-only-badge.png[Example of Discover's read only access indicator in Kibana's header]
 [float]
-=== Save a search
+=== Save a Discover session
 
-By default, a saved search stores the query text, filters, and
+By default, a Discover session stores the query text, filters, and
 current view of *Discover*, including the columns and sort order in the document table, and the {data-source}.
 
-. Once you've created a search worth saving, click *Save* in the toolbar.
-. Enter a name for the search.
-. Optionally store <<managing-tags,tags>> and the time range with the search.
+. Once you've created a view worth saving, click *Save* in the toolbar.
+. Enter a name for the session.
+. Optionally store <<managing-tags,tags>> and the time range with the session.
 . Click *Save*.
-. To reload your search results in *Discover*, click *Open* in the toolbar, and select the saved search.
+. To reload your search results in *Discover*, click *Open* in the toolbar, and select the saved Discover session.
 +
-If the saved search is associated with a different {data-source} than is currently
-selected, opening the saved search changes the selected {data-source}. The query language
-used for the saved search is also automatically selected.
+If the saved Discover session is associated with a different {data-source} than is currently
+selected, opening the saved Discover session changes the selected {data-source}. The query language
+used for the saved Discover session is also automatically selected.
 
 [float]
-=== Duplicate a search
-. In **Discover**, open the search that you want to duplicate.
+=== Duplicate a Discover session
+. In **Discover**, open the Discover session that you want to duplicate.
 . In the toolbar, click *Save*.
-. Give the search a new name.
-. Turn on **Save as new search**.
+. Give the session a new name.
+. Turn on **Save as new Discover session**.
 . Click *Save*.
 
 
@@ -46,5 +46,5 @@ used for the saved search is also automatically selected.
 . Go to *Dashboards*.
 . Open or create the dashboard, then click *Edit*.
 . Click *Add from library*.
-. From the *Types* dropdown, select *Saved search*.
-. Select the saved search that you want to visualize, then click *X* to close the list.
+. From the *Types* dropdown, select *Discover session*.
+. Select the Discover session that you want to add, then click *X* to close the list.
diff --git a/docs/discover/search-sessions.asciidoc b/docs/discover/search-sessions.asciidoc
@@ -52,7 +52,7 @@ image::images/search-session-awhile.png[Search Session indicator displaying the
 Once you save a search session, you can start a new search,
 navigate to a different application, or close the browser.
 
-. To view your saved searches, go to the
+. To view your saved search sessions, go to the
 *Search Sessions* management page using the navigation menu or the <<kibana-navigation-search,global search field>>.
 For a saved or completed session, you can also open this view from the search sessions popup.
 

diff --git a/docs/discover/search.asciidoc b/docs/discover/search.asciidoc
@@ -92,10 +92,10 @@ status:[400 TO 499] AND (extension:php OR extension:html)
 
 
 [[save-open-search]]
-=== Save a search
-A saved search persists your current view of Discover for later retrieval and reuse. You can reload a saved search into Discover, add it to a dashboard, and use it as the basis for a visualization.
+=== Save a Discover session
+A saved Discover session persists your current view of Discover for later retrieval and reuse. You can reload a saved session into Discover, add it to a dashboard, and use it as the basis for a visualization.
 
-A saved search includes the query text, filters, and optionally, the time filter. A saved search also includes the selected columns in the document table, the sort order, and the current index pattern.
+A Discover session includes the query text, filters, and optionally, the time filter. A Discover session also includes the selected columns in the document table, the sort order, and the current {data-source}.
 
 [role="xpack"]
 [[discover-read-only-access]]
@@ -107,23 +107,23 @@ Kibana see <<xpack-security-authorization>>.
 [role="screenshot"]
 image::discover/images/read-only-badge.png[Example of Discover's read only access indicator in Kibana's header]
 
-==== Save a search
-To save the current search:
+==== Save a Discover session
+To save the current session:
 
 . Click *Save* in the toolbar.
-. Enter a name for the search and click *Save*.
+. Enter a name for the session and click *Save*.
 
-To import, export, and delete saved searches, go to the *Saved Objects* management page using the navigation menu or the <<kibana-navigation-search,global search field>>.
+To import, export, and delete saved Discover sessions, go to the *Saved Objects* management page using the navigation menu or the <<kibana-navigation-search,global search field>>.
 
-==== Open a saved search
-To load a saved search into Discover:
+==== Open a saved Discover session
+To load a saved session into Discover:
 
 . Click *Open* in the toolbar.
-. Select the search you want to open.
+. Select the session you want to open.
 
-If the saved search is associated with a different index pattern than is currently
-selected, opening the saved search changes the selected index pattern. The query language
-used for the saved search will also be automatically selected.
+If the saved Discover session is associated with a different {data-source} than is currently
+selected, opening the saved Discover session changes the selected {data-source}. The query language
+used for the saved Discover session will also be automatically selected.
 
 [[save-load-delete-query]]
 === Save a query
@@ -133,7 +133,7 @@ A saved query is a portable collection of query text and filters that you can re
 * View the results of the same query in multiple apps
 * Share your query
 
-Saved queries don't include information specific to Discover, such as the currently selected columns in the document table, the sort order, and the index pattern. If you want to save your current view of Discover for later retrieval and reuse, create a <<save-open-search, saved search>> instead.
+Saved queries don't include information specific to Discover, such as the currently selected columns in the document table, the sort order, and the {data-source}. If you want to save your current view of Discover for later retrieval and reuse, create a <<save-open-search, Discover session>> instead.
 
 [role="xpack"]
 ==== Read-only access

diff --git a/docs/fleet/fleet.asciidoc b/docs/fleet/fleet.asciidoc
@@ -18,7 +18,7 @@ It is recommended for advanced users only.
 [role="screenshot"]
 image::fleet/images/fleet-start.png[{fleet} app in {kib}]
 
-Most integration content installed by {fleet} isn’t editable. This content is tagged with a **Managed** badge in the {kib} UI. Managed content itself cannot be edited or deleted, however managed visualizations, dashboards, and saved searches can be cloned.   
+Most integration content installed by {fleet} isn’t editable. This content is tagged with a **Managed** badge in the {kib} UI. Managed content itself cannot be edited or deleted, however managed visualizations, dashboards, and Discover sessions can be cloned.   
 
 [role="screenshot"]
 image::fleet/images/system-managed.png[An image of the new managed badge.]
@@ -37,7 +37,7 @@ To clone a dashboard:
 . Click *Save and return* after editing the dashboard.
 . Click *Save*.
 
-To clone managed content relating to specific visualization editors, such as Lens, TSVB, and Maps, view the visualization in the editor then begin to make edits. Unlike cloning dashboards, and dashboard panels, the cloned content retains the original configurations. Once finished you are prompted to save the edits as a new visualization. The same applies for altering any saved searches in a managed visualization. 
+To clone managed content relating to specific visualization editors, such as Lens, TSVB, and Maps, view the visualization in the editor then begin to make edits. Unlike cloning dashboards, and dashboard panels, the cloned content retains the original configurations. Once finished you are prompted to save the edits as a new visualization. The same applies for altering any linked Discover sessions in a managed visualization. 
 
 [float]
 == Get started

diff --git a/docs/management/advanced-options.asciidoc b/docs/management/advanced-options.asciidoc
@@ -311,7 +311,7 @@ Sets the maximum number of rows for the entire document table. This is the maxim
 
 [[discover-searchonpageload]]`discover:searchOnPageLoad`::
 Controls whether a search is executed when *Discover* first loads. This setting
-does not have an effect when loading a saved search.
+does not have an effect when loading a saved Discover session.
 
 [[discover:showFieldStatistics]]`discover:showFieldStatistics`::
 beta[] Enables the Field statistics view. Examine details such as
@@ -324,10 +324,10 @@ Controls the display of multi-fields in the expanded document view.
 The default sort direction for time-based data views.
 
 [[doctable-hidetimecolumn]]`doc_table:hideTimeColumn`::
-Hides the "Time" column in *Discover* and in all saved searches on dashboards.
+Hides the "Time" column in *Discover* and in all Discover session panels on dashboards.
 
 [[doctable-highlight]]`doc_table:highlight`::
-Highlights results in *Discover* and saved searches on dashboards. Highlighting
+Highlights search results in *Discover* and Discover session panels on dashboards. Highlighting
 slows requests when working on big documents.
 
 

diff --git a/docs/setup/configuring-reporting.asciidoc b/docs/setup/configuring-reporting.asciidoc
@@ -121,8 +121,8 @@ PUT <kibana host>:<port>/api/security/role/custom_reporting_user
 // CONSOLE
 
 <1> Grants access to generate PNG and PDF reports in *Dashboard*.
-<2> Grants access to generate CSV reports from saved search panels in *Dashboard*.
-<3> Grants access to generate CSV reports from saved searches in *Discover*.
+<2> Grants access to generate CSV reports from saved Discover session panels in *Dashboard*.
+<3> Grants access to generate CSV reports from saved Discover sessions in *Discover*.
 <4> Grants access to generate PDF reports in *Canvas*.
 <5> Grants access to generate PNG and PDF reports in *Visualize Library*.
 
@@ -157,8 +157,8 @@ PUT localhost:5601/api/security/role/custom_reporting_user
 ---------------------------------------------------------------
 // CONSOLE
 
-<1> Grants access to generate CSV reports from saved searches in *Discover*.
-<2> Grants access to generate CSV reports from saved search panels in *Dashboard*.
+<1> Grants access to generate CSV reports from saved Discover sessions in *Discover*.
+<2> Grants access to generate CSV reports from saved Discover session panels in *Dashboard*.
 
 [float]
 [[grant-user-access-external-provider]]

diff --git a/docs/user/dashboard/aggregation-based.asciidoc b/docs/user/dashboard/aggregation-based.asciidoc
@@ -7,7 +7,7 @@ With aggregation-based visualizations, you can:
 
 * Split charts up to three aggregation levels, which is more than *Lens* and *TSVB*
 * Create visualization with non-time series data
-* Use a <<save-open-search,saved search>> as an input
+* Use a <<save-open-search,Discover session>> as an input
 * Sort data tables and use the summary row and percentage column features
 * Assign colors to data series
 * Extend features with plugins
@@ -112,7 +112,7 @@ Choose the type of visualization you want to create, then use the editor to conf
 
 .. Select the data source you want to visualize.
 +
-NOTE: There is no performance impact on the data source you select. For example, *Discover* saved searches perform the same as {data-sources}. 
+NOTE: There is no performance impact on the data source you select. For example, saved Discover sessions perform the same as {data-sources}. 
 
 . Add the <<aggregation-reference,aggregations>> you want to visualize using the editor, then click *Update*. 
 +

diff --git a/docs/user/dashboard/create-visualizations.asciidoc b/docs/user/dashboard/create-visualizations.asciidoc
@@ -163,9 +163,9 @@ To enable series data interactions, configure <<settings-explore-data-in-chart,`
 +
 To use series data interactions, click a data series in the panel.
 
-* *Saved search interactions* &mdash; Opens <<save-your-search,saved search>> data in *Discover*.
+* *Discover session interactions* &mdash; Opens <<save-your-search,saved Discover session>> data in *Discover*.
 +
-To use saved search interactions, open the panel menu, then click *More > View saved search*.
+To use saved Discover session interactions, open the panel menu, then click *More > View Discover session*.
 
 [[edit-panels]]
 === Edit panels

diff --git a/docs/user/dashboard/lens.asciidoc b/docs/user/dashboard/lens.asciidoc
@@ -668,10 +668,10 @@ For area, line, and bar charts, press Shift, then click the series in the legend
 
 [discrete]
 [[is-it-possible-to-use-saved-serches-in-lens]]
-.*How do I visualize saved searches?*
+.*How do I visualize saved Discover sessions?*
 [%collapsible]
 ====
-Visualizing saved searches in unsupported.
+Visualizing saved Discover sessions in unsupported.
 ====
 
 [discrete]

diff --git a/docs/user/dashboard/tsvb.asciidoc b/docs/user/dashboard/tsvb.asciidoc
@@ -233,7 +233,7 @@ For example `https://example.org/{{key}}`
 
 This instructs TSVB to substitute the value from your visualization wherever it sees `{{key}}`.
 
-If your data contain reserved or invalid URL characters such as "#" or "&", you should apply a transform to URL-encode the key like this `{{encodeURIComponent key}}`. If you are dynamically constructing a drilldown to another location in Kibana (for example, clicking a table row takes to you a value-scoped saved search), you will likely want to Rison-encode your key as it may contain invalid Rison characters. (https://github.com/Nanonid/rison#rison---compact-data-in-uris[Rison] is the serialization format many parts of Kibana use to store information in their URL.)
+If your data contain reserved or invalid URL characters such as "#" or "&", you should apply a transform to URL-encode the key like this `{{encodeURIComponent key}}`. If you are dynamically constructing a drilldown to another location in Kibana (for example, clicking a table row takes to you a value-scoped Discover session), you will likely want to Rison-encode your key as it may contain invalid Rison characters. (https://github.com/Nanonid/rison#rison---compact-data-in-uris[Rison] is the serialization format many parts of Kibana use to store information in their URL.)
 
 For example: `discover#/view/0ac50180-82d9-11ec-9f4a-55de56b00cc0?_a=(filters:!((query:(match_phrase:(foo.keyword:{{rison key}})))))`