Skip to content

Commit dc1c9f6

Browse files
florent-leborgnecursoragentvishaangelova
authored
docs: update dashboard panel workflows for the Add to dashboard flyout (#6353) (#7189)
## Summary A bit overdue. Did a few phrasing tricks to keep instructions true without splitting into too many applies_to bullets, which are conscious choices and may explain some unusual ways to phrase some menu instructions. This PR addresses #6353. In 9.5, clicking **Add** on a dashboard no longer opens a popover; it opens a single **Add to dashboard** flyout with **New** and **From library** tabs, featured **Visualization** and **Visualization (query)** items, a renamed **Other visualizations** group (was "Visualizations"), and **Vega** (was "Custom visualization"). These changes update the affected panel-adding workflows across the docs, using the cumulative model so earlier-version steps are preserved. - **`explore-analyze/visualize.md`**: Adds a canonical description of the **Add to dashboard** flyout (New / From library tabs, featured items, grouped panel types), updates "Add panel" flow/menu wording to the version-neutral **Add** menu, and renames the panel-type entry to **Vega**. - **`explore-analyze/dashboards/drilldowns.md`**: Adds a 9.5+ flyout variant for the "add from library" and "create visualization" steps and caps the popover wording at 9.2–9.4 (issue-requested). - **`explore-analyze/visualize/esorql.md`**, **`_snippets/emoji-table-esql.md`**, **`kibana-data-exploration-learning-tutorial.md`**: Updates the ES|QL panel steps — the removed **New panel** item and the renamed **Other visualizations** group — to use the **Visualization (query)** featured item in 9.5+. - **`explore-analyze/visualize/link-panels.md`**, **`text-panels.md`**, **`image-panels.md`**, **`alert-panels.md`**: Normalizes the "add a panel" / "add from library" steps to the flyout, with cumulative version bullets. - **`explore-analyze/discover/save-open-search.md`**: Updates the "create a Discover session on the dashboard" steps (Discover session now sits under **Other visualizations** in 9.5+). - **`explore-analyze/visualize/custom-visualizations-with-vega.md`**: Renames **Custom visualization** to **Vega** (label change verified in source). All UI strings were verified against `elastic/kibana` at `origin/main` (HEAD), not just the original PR diff — see note below. ## Resolves Closes #6353 ## Verification notes - Feature shipped in [elastic/kibana#264457](elastic/kibana#264457) (v9.5.0). A follow-up, [elastic/kibana#271437](elastic/kibana#271437), moved the two featured items from a hardcoded list to actions on a `FEATURED_ADD_PANEL_TRIGGER`; the visible result is unchanged, but the original PR's `featured_menu_items.ts` no longer exists, so all labels were re-confirmed at HEAD. - Confirmed strings: **Add** button, **Add to dashboard** flyout, **New** / **From library** tabs, **Visualization** ("Build charts, metrics, and tables with a point-and-click editor."), **Visualization (query)** ("Build charts, metrics, and tables with ES|QL."), **Other visualizations** group, **Vega**. Discover session is registered under `ADD_PANEL_VISUALIZATION_GROUP` (**Other visualizations**). ## Out of scope (intentional) - Tutorial steps that read `Select **Add** > **Visualization**` in `create-dashboard-of-panels-with-ecommerce-data.md` and `create-dashboard-of-panels-with-web-server-data.md` were left unchanged: the label path still resolves correctly in the 9.5 flyout (**Add**, then the **Visualization** featured item). - `add-controls.md` (`Add > Controls > …`) was left unchanged; the controls flow is a separate area not covered by this redesign issue. - `create-dashboard.md` was left unchanged: it describes panel-adding at a high level and links to `visualize.md`, where the flyout is now documented. ## Screenshots to add or update - [x] `explore-analyze/visualize.md` — new **Add to dashboard** flyout: consider adding a screenshot of the flyout (New tab with featured items) since it is a new, visually distinct surface for evaluators and new users. Prose describes it, but the layout is easier to grasp visually. -> no value, not adding --- > **AI-generated draft** — created with Claude Opus 4.8. > Review all generated content for factual accuracy before merging. --------- Co-authored-by: Cursor <cursoragent@cursor.com> Co-authored-by: Visha Angelova <91186315+vishaangelova@users.noreply.github.com>
1 parent a40e002 commit dc1c9f6

11 files changed

Lines changed: 43 additions & 34 deletions

explore-analyze/dashboards/drilldowns.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ Use the [**Sample web logs**](../index.md#gs-get-data-into-kibana) data to creat
6262
1. Add the **Sample web logs** data.
6363
2. Create a new dashboard.
6464

65-
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** > **From library** in the application menu.
66-
* {applies_to}`stack: ga 9.0-9.1` Click **Add from library** in the dashboard toolbar.
65+
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** in the application menu, then select **From library**.
66+
* {applies_to}`stack: ga 9.0-9.1` Select **Add from library** in the application menu.
6767

6868
3. Add the following panel:
6969

@@ -118,8 +118,8 @@ For example, if you have a dashboard that shows data from a Github repository, y
118118
3. In the application menu, click **Edit**.
119119
4. Create a pie chart.
120120

121-
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** > **Visualization** in the application menu.
122-
* {applies_to}`stack: ga 9.0-9.1` Click **Create visualization** in the dashboard toolbar.
121+
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** in the application menu, then select **Visualization**.
122+
* {applies_to}`stack: ga 9.0-9.1` Select **Create visualization** in the application menu.
123123

124124
2. From the **Chart type** dropdown, select **Pie**.
125125
3. From the **Available fields** list, drag **machine.os.keyword** to the workspace.

explore-analyze/discover/save-open-search.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -189,10 +189,9 @@ Use this option to create a single-tab Discover session directly on the dashboar
189189

190190
You need permission to access Discover, and the dashboard must be in **Edit** mode.
191191

192-
1. On the dashboard, select **Add panel** > **New panel**.
193-
2. In the **Visualizations** group, select {icon}`app_discover` **Discover session**. Discover opens in embedded editor mode.
194-
3. Configure the session: enter a query, adjust columns, sort, and other view settings as needed.
195-
4. Select **Save and return** in the application menu to add the configured panel to the dashboard.
192+
1. From the application menu, add a new **Discover session** panel.
193+
2. Configure the session: enter a query, adjust columns, sort, and apply other view settings as needed.
194+
3. Select **Save and return** in the application menu to add the configured panel to the dashboard.
196195

197196
### Manage Discover session panels on a dashboard [manage-discover-session-panels]
198197

explore-analyze/kibana-data-exploration-learning-tutorial.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -282,8 +282,8 @@ You can also add panels powered by {{esql}} queries directly from the dashboard.
282282

283283
1. Add a new panel:
284284

285-
- {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** > **New panel** in the toolbar, then select **{{esql}}** under **Visualizations**.
286-
- {applies_to}`stack: ga 9.0-9.1` Select **Add panel** in the toolbar, then select **{{esql}}** under **Visualizations**.
285+
- {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** in the application menu, then select **Visualization (query)** or **New panel****{{esql}}** under **Visualizations**, depending on your {{kib}} version.
286+
- {applies_to}`stack: ga 9.0-9.1` Select **Add panel** in the application menu, then select **{{esql}}** under **Visualizations**.
287287

288288
2. Enter the following query and run it:
289289

@@ -1038,7 +1038,7 @@ One of {{kib}}'s strengths is how you can move between exploring raw data and vi
10381038
: Select {icon}`pencil` on any panel to open the inline **Configuration** flyout. For deeper changes, select **Edit in Lens** in the flyout to switch to the full editor, then **Save and return** to go back to the dashboard.
10391039

10401040
**Add a new visualization directly from a dashboard**
1041-
: From a dashboard, select **Add** > **Visualization** to open the Lens editor, or **Add** > **New panel** and then **ES|QL** under **Visualizations** to create a chart from an {{esql}} query without going through Discover first.
1041+
: From a dashboard, select **Add**, then select **Visualization** to open the Lens editor, or **Visualization (query)** to create a chart from an {{esql}} query without going through Discover first.
10421042

10431043
:::{tip}
10441044
This back-and-forth workflow is especially useful when investigating anomalies: spot something unusual on a dashboard, jump to Discover to examine the raw events, refine your query, then save an updated visualization back to the dashboard.

explore-analyze/visualize.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ $$$panels-editors$$$
2020
| --- | --- | --- |
2121
| Visualizations | [Lens](visualize/lens.md) | Create powerful charts in {{kib}}. This is the default editor. |
2222
| | [{{esql}}](/explore-analyze/query-filter/languages/esql-kibana.md) | Create visualizations from {{esql}} queries |
23-
| | [Discover sessions](discover.md) {applies_to}`stack: ga 9.4` {applies_to}`serverless: ga` | Create a Discover session directly in your dashboard. Saved sessions can be added to multiple dashboards from the **Add panel** flow. |
23+
| | [Discover sessions](discover.md) {applies_to}`stack: ga 9.4` {applies_to}`serverless: ga` | Create a Discover session directly in your dashboard. Saved sessions can be added to multiple dashboards from the dashboard **Add** menu. |
2424
| | [Maps](visualize/maps.md) | Create beautiful displays of your geographical data |
2525
| | [Alerts](visualize/alert-panels.md) | View Observability or Security alerts in your dashboard |
26-
| | [Custom visualizations](visualize/custom-visualizations-with-vega.md) | Use Vega to create new types of visualizations |
26+
| | [Vega or custom visualizations](visualize/custom-visualizations-with-vega.md) | Use Vega to create new types of visualizations |
2727
| | | |
2828
| Annotations and navigation | [Collapsible sections](dashboards/arrange-panels.md#collapsible-sections) | Organize your dashboard into sections that can be collapsed and save loading time |
2929
| | [Markdown text](visualize/text-panels.md) | Add context to your dashboard with markdown-based **text** |
@@ -44,5 +44,5 @@ $$$panels-editors$$$
4444
| | [TSVB](visualize/legacy-editors/tsvb.md) | Visualize time-based data through various panel types |
4545

4646
:::{note}
47-
Legacy panel types only appear in the **Add panel** dashboard menu if you already have such panels in your dashboards. If you have never used these panel types, use Lens instead.
47+
Legacy panel types only appear in the dashboard **Add** menu if you already have such panels in your dashboards. If you have never used these panel types, use Lens instead.
4848
:::

explore-analyze/visualize/_snippets/emoji-table-esql.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ To create the visualization:
1717

1818
1. Open a dashboard and add a new {{esql}} visualization:
1919

20-
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** > **New panel** in the toolbar, then choose **{{esql}}** under **Visualizations**.
21-
* {applies_to}`stack: ga 9.0-9.1` Click **Add panel** in the dashboard toolbar, then choose **{{esql}}**.
20+
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** in the application menu, then select **Visualization (query)** or **New panel****{{esql}}** under **Visualizations**, depending on your {{kib}} version.
21+
* {applies_to}`stack: ga 9.0-9.1` Select **Add panel** in the application menu, then select **{{esql}}**.
2222

2323
2. Enter the following query:
2424

explore-analyze/visualize/alert-panels.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,12 @@ To view alerts in a dashboard, add **Alerts** panels that show selected alerts.
1212

1313
## Create an alerts panel
1414

15-
1. From your dashboard, select **Add panel**.
16-
2. In the **Add panel** flyout, select **Alerts**. The configuration flyout appears.
15+
1. Open the panel menu from your dashboard.
16+
17+
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** in the application menu and, if required, **New panel**.
18+
* {applies_to}`stack: ga 9.1` Select **Add panel** in the application menu.
19+
20+
2. Select **Alerts**. The configuration flyout appears.
1721
3. ({{stack}} deployments only) Under **Solution**, select either **Observability** or **Security** to specify the type of alerts you want to display.
1822
4. Under **Filter by** select either **Rule tags** or **Rule types**.
1923
5. (Optional) To use both types of filters, first define one filter, then use the boolean **+ OR** or **+ AND** options that appear to define the second filter.

explore-analyze/visualize/custom-visualizations-with-vega.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Before starting, add the eCommerce sample data that you’ll use in your spec, t
6161

6262
Open **Vega-Lite** and change the time range.
6363

64-
1. On the dashboard, click **Select type**, then select **Custom visualization**.
64+
1. In the application menu, select **Vega** or **Custom visualization**, depending on your {{kib}} version.
6565

6666
A pre-populated line chart displays the total number of documents.
6767

explore-analyze/visualize/esorql.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,16 @@ You can then **Save** and add it to an existing or a new dashboard using the sav
3636

3737
1. Add a new panel from your dashboard.
3838

39-
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** > **New panel** in the toolbar.
40-
* {applies_to}`stack: ga 9.0-9.1` Click **Add panel** in the dashboard toolbar.
39+
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** in the application menu and, if required, **New panel**.
40+
* {applies_to}`stack: ga 9.0-9.1` Select **Add panel** in the application menu.
4141

4242
::::{tip}
4343
If you haven't created a [data view](/explore-analyze/find-and-organize/data-views.md) and you don't have a dashboard yet, the **Dashboards** page offers you the possibility to **Try ES|QL** right away. By selecting this option, a dashboard is created with an ES|QL visualization that you can interact with and configure using ES|QL.
4444
::::
4545

46-
2. Choose **ES|QL** under **Visualizations**. An ES|QL editor appears and lets you configure your query and its associated visualization. The **Suggestions** panel can help you find alternative ways to configure the visualization.
46+
2. Select **Visualization (query)** or **ES|QL** under **Visualizations**, depending on your {{kib}} version.
47+
48+
An ES|QL editor appears and lets you configure your query and its associated visualization. The **Suggestions** panel can help you find alternative ways to configure the visualization.
4749

4850
::::{tip}
4951
Check the [ES|QL reference](elasticsearch://reference/query-languages/esql.md) to get familiar with the syntax and [optimize your query](elasticsearch://reference/query-languages/esql/esql-query-performance.md).

explore-analyze/visualize/image-panels.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,12 @@ Image uploads are limited to 10 MiB.
2020

2121
You can upload images from your computer, select previously uploaded images, or add images from an external link.
2222

23-
1. From your dashboard, select **Add panel**.
24-
2. In the **Add panel** flyout, select **Image**. The **Add image** flyout appears and lets you add and configure the image you want to display.
23+
1. From your dashboard, open the panel menu.
24+
25+
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** in the application menu and, if required, **New panel**.
26+
* {applies_to}`stack: ga 9.0-9.1` Select **Add panel** in the application menu.
27+
28+
2. Select **Image**. The **Add image** flyout appears and lets you add and configure the image you want to display.
2529
3. Add your image and configure the settings, and then click **Save**.
2630

2731
:::{image} /explore-analyze/images/kibana-dashboard_addImageEditor_8.7.0.png

explore-analyze/visualize/link-panels.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ You can use **Links** panels to create links to other dashboards or external web
2424

2525
## Add a links panel [add-links-panel]
2626

27-
1. Add a new panel.
27+
1. Open the panel menu.
2828

29-
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** > **New panel** in the toolbar.
30-
* {applies_to}`stack: ga 9.0-9.1` Click **Add panel** in the dashboard toolbar.
29+
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** in the application menu and, if required, **New panel**.
30+
* {applies_to}`stack: ga 9.0-9.1` Select **Add panel** in the application menu.
3131

32-
2. In the **Add panel** flyout, select **Links**. The **Create links panel** flyout appears and lets you add the link you want to display.
32+
2. Select **Links**. The **Create links panel** flyout appears and lets you add the link you want to display.
3333
3. Choose between the panel displaying vertically or horizontally on your dashboard and add your link.
3434
4. Specify the following:
3535

@@ -46,10 +46,10 @@ You can use **Links** panels to create links to other dashboards or external web
4646

4747
To add a previously saved links panel to another dashboard:
4848

49-
1. Open the **Add from library** flyout.
49+
1. Open the library panel menu.
5050

51-
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** > **From library** in the toolbar.
52-
* {applies_to}`stack: ga 9.0-9.1` Click **Add from library** in the dashboard toolbar.
51+
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** in the application menu, then select **From library**.
52+
* {applies_to}`stack: ga 9.0-9.1` Select **Add from library** in the application menu.
5353

5454
2. Select **Links** from the **Types** dropdown and then select the Links panel you want to add.
5555
3. Click **Save**.

0 commit comments

Comments
 (0)