Skip to content

Commit 17011b7

Browse files
authored
[DOCS] Empty dashboard screen (elastic#55727)
* [DOCS] AdEmpty dashboard screen redesign * Review comments f from Gail * Comments from Gaiail pt 2
1 parent c71f4dd commit 17011b7

File tree

2 files changed

+82
-74
lines changed

2 files changed

+82
-74
lines changed
Loading

docs/user/dashboard.asciidoc

+82-74
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,23 @@
44
[partintro]
55
--
66

7-
A {kib} _dashboard_ is a collection of visualizations, searches, and
8-
maps, typically in real-time. Dashboards provide
9-
at-a-glance insights into your data and enable you to drill down into details.
7+
A _dashboard_ is a collection of visualizations, searches, and
8+
maps, typically in real-time. Dashboards provide
9+
at-a-glance insights into your data and enable you to drill down into details.
1010

11-
To start working with dashboards, click *Dashboard* in the side navigation.
1211
With *Dashboard*, you can:
1312

14-
* <<dashboard-create-new-dashboard, Create a dashboard>>
15-
* <<customizing-your-dashboard, Arrange dashboard elements>>
16-
* <<dashboard-customize-filter, Customize time ranges>>
17-
* <<sharing-dashboards, Share a dashboard>>
18-
* <<import-dashboards, Import and export dashboards>>
19-
* <<viewing-detailed-information, Inspect and edit dashboard elements>>
13+
* Add visualizations, saved searches, and maps for side-by-side analysis
2014

15+
* Arrange dashboard elements to display exactly how you want
16+
17+
* Customize time ranges to display only the data you want
18+
19+
* Inspect and edit dashboard elements to find out exactly what kind of data is displayed
2120

2221
[role="screenshot"]
2322
image:images/Dashboard_example.png[Example dashboard]
2423

25-
2624
[float]
2725
[[dashboard-read-only-access]]
2826
=== [xpack]#Read only access#
@@ -32,56 +30,61 @@ then you don't have sufficient privileges to create and save dashboards. The but
3230
dashboards are not visible. For more information, see <<xpack-security-authorization>>.
3331

3432
[role="screenshot"]
35-
image::images/dashboard-read-only-badge.png[Example of Dashboard's read only access indicator in Kibana's header]
33+
image::images/dashboard-read-only-badge.png[Example of Dashboard read only access indicator in Kibana header]
3634

37-
[float]
38-
[[dashboard-getting-started]]
39-
=== Interact with dashboards
35+
--
36+
37+
[[dashboard-create-new-dashboard]]
38+
== Create a dashboard
4039

41-
When you open *Dashboard*, you're presented an overview of your dashboards.
42-
If you don't have any dashboards, you can add
40+
To create a dashboard, you must have data indexed into {es}, an index pattern
41+
to retrieve the data from {es}, and
42+
visualizations, saved searches, or maps. If these don't exist, you're prompted to
43+
add them as you create the dashboard, or you can add
4344
<<add-sample-data, sample data sets>>,
44-
which include pre-built dashboards.
45+
which include pre-built dashboards.
4546

46-
Once you open a dashboard, you can filter the data
47-
by entering a search query, changing the time filter, or clicking
48-
in the visualizations, searches, and maps. If a dashboard element has a stored query,
49-
both queries are applied.
47+
To begin, open *Dashboard*, then click *Create new dashboard.*
5048

51-
--
49+
[float]
50+
[[dashboard-add-elements]]
51+
=== Add elements
5252

53-
[[dashboard-create-new-dashboard]]
54-
== Create a dashboard
53+
The visualizations, saved searches, and maps are stored as elements in panels
54+
that you can move and resize.
5555

56-
To create a dashboard, you must have data indexed into {es}, an index pattern
57-
to retrieve the data from {es}, and
58-
visualizations, saved searches, or maps. If these don't exist, you're prompted to
59-
add them as you create the dashboard.
56+
You can add elements from multiple indices, and the same element can appear in
57+
multiple dashboards.
6058

61-
For an end-to-end example, see <<tutorial-build-dashboard, Building your own dashboard>>.
59+
To create an element:
60+
61+
. Click *Create new*.
62+
. On the *New Visualization* window, click the visualization type.
63+
+
64+
[role="screenshot"]
65+
image:images/Dashboard_add_new_visualization.png[Example add new visualization to dashboard]
66+
+
67+
For information on how to create visualizations, see <<visualize,Visualize>>.
68+
+
69+
For information on how to create Maps, see <<maps,Elastic Maps>>.
70+
71+
To add an existing element:
6272

63-
. Open *Dashboard.*
64-
. Click *Create new dashboard.*
6573
. Click *Add*.
66-
. Use *Add panels* to add elements to the dashboard.
74+
75+
. On the *Add panels* flyout, select the panel.
6776
+
68-
The visualizations, saved searches, and maps
69-
are stored in panels that you can move and resize. A
70-
menu in the upper right of the panel has options for customizing
71-
the panel. You can add elements from
72-
multiple indices, and the same element can appear in multiple dashboards.
77+
When a dashboard element has a stored query,
78+
both queries are applied.
7379
+
7480
[role="screenshot"]
7581
image:images/Dashboard_add_visualization.png[Example add visualization to dashboard]
7682

77-
. When you're finished adding and arranging the panels,
78-
*Save* the dashboard.
79-
8083
[float]
8184
[[customizing-your-dashboard]]
8285
=== Arrange dashboard elements
8386

84-
In *Edit* mode, you can move, resize, customize, and delete panels to suit your needs.
87+
In *Edit* mode, you can move, resize, customize, and delete panels to suit your needs.
8588

8689
[[moving-containers]]
8790
* To move a panel, click and hold the panel header and drag to the new location.
@@ -95,37 +98,64 @@ to the new dimensions.
9598
* To delete a panel, open the panel menu and select *Delete from dashboard.* Deleting a panel from a
9699
dashboard does *not* delete the saved visualization or search.
97100

101+
[float]
102+
[[viewing-detailed-information]]
103+
=== Inspect and edit elements
104+
105+
Many dashboard elements allow you to drill down into the data and requests
106+
behind the element.
107+
108+
From the panel menu, select *Inspect*.
109+
The data that displays depends on the element that you inspect.
110+
111+
[role="screenshot"]
112+
image:images/Dashboard_inspect.png[Inspect in dashboard]
113+
114+
To open an element for editing, put the dashboard in *Edit* mode,
115+
and then select *Edit visualization* from the panel menu. The changes you make appear in
116+
every dashboard that uses the element.
117+
98118
[float]
99119
[[dashboard-customize-filter]]
100120
=== Customize time ranges
101121

102122
You can configure each visualization, saved search, and map on your dashboard
103123
for a specific time range. For example, you might want one visualization to show
104-
the monthly trend for CPU usage and another to show the current CPU usage.
124+
the monthly trend for CPU usage and another to show the current CPU usage.
105125

106-
From the panel menu, select *Customize time range* to expose a time filter
107-
dedicated to that panel. Panels that are not restricted by a specific
126+
From the panel menu, select *Customize time range* to expose a time filter
127+
dedicated to that panel. Panels that are not restricted by a specific
108128
time range are controlled by the
109129
global time filter.
110130

111131
[role="screenshot"]
112132
image:images/time_range_per_panel.gif[Time range per dashboard panel]
113133

114134
[float]
135+
[[save-dashboards]]
136+
=== Save the dashboard
137+
138+
When you're finished adding and arranging the panels, save the dashboard.
139+
140+
. In the {kib} toolbar, click *Save*.
141+
142+
. Enter the dashboard *Title* and optional *Description*, then *Save* the dashboard.
143+
115144
[[sharing-dashboards]]
116-
=== Share a dashboard
145+
=== Share the dashboard
117146

118147
[[embedding-dashboards]]
119-
When you've finished your dashboard, you can share it with your teammates.
148+
Share your dashboard outside of {kib}.
149+
120150
From the *Share* menu, you can:
121151

122-
* Embed the code in a web page. Users must have Kibana access
152+
* Embed the code in a web page. Users must have {kib} access
123153
to view an embedded dashboard.
124154
* Share a direct link to a {kib} dashboard
125155
* Generate a PDF report
126156
* Generate a PNG report
127157

128-
TIP: You can create a link to a dashboard by title by doing this: +
158+
TIP: To create a link to a dashboard by title, use: +
129159
`${domain}/${basepath?}/app/kibana#/dashboards?title=${yourdashboardtitle}`
130160

131161
TIP: When sharing a link to a dashboard snapshot, use the *Short URL*. Snapshot
@@ -134,29 +164,7 @@ tools. To create a short URL, you must have write access to {kib}.
134164

135165
[float]
136166
[[import-dashboards]]
137-
=== Import and export dashboards
138-
139-
To import and export dashboards, go to *Management > Saved Objects*. For details,
140-
see <<managing-saved-objects, Managing saved objects>>.
141-
142-
[float]
143-
[[viewing-detailed-information]]
144-
=== Inspect and edit elements
145-
146-
Many dashboard elements allow you to drill down into the data and requests
147-
behind the element. Open the menu in the upper right of the panel and select *Inspect*.
148-
The views you see depend on the element that you inspect.
149-
150-
[role="screenshot"]
151-
image:images/Dashboard_inspect.png[Inspect in dashboard]
152-
153-
To open an element for editing, put the dashboard in *Edit* mode,
154-
and then select *Edit* from the panel menu. The changes you make appear in
155-
every dashboard that uses the element.
156-
157-
158-
159-
160-
161-
167+
=== Export the dashboard
162168

169+
To export the dashboard, go to *Management > Saved Objects*. For more information,
170+
see <<managing-saved-objects, Managing saved objects>>.

0 commit comments

Comments
 (0)