Skip to content

Commit 75b20b3

Browse files
KOTungsethgchapswylieconlon
authored
[DOCS] Dashboard-first docs refresh (#76194) (#76717)
* [DOCS] Dashboard-first refresh * Fixes broken links and partinto error * Fixes images in panel table * Fixes broken links * Fixes broken drilldowns link * Fixes images and table * Removed un needed files and added edit content * Update docs/getting-started/tutorial-visualizing.asciidoc Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Review comments * Review comments * Removed blocks * Typo fix * Update docs/getting-started/tutorial-sample-data.asciidoc Co-authored-by: Wylie Conlon <wylieconlon@gmail.com> * Update docs/getting-started/tutorial-discovering.asciidoc Co-authored-by: Wylie Conlon <wylieconlon@gmail.com> * Update docs/getting-started/tutorial-sample-data.asciidoc Co-authored-by: Wylie Conlon <wylieconlon@gmail.com> * Update docs/getting-started/tutorial-visualizing.asciidoc Co-authored-by: Wylie Conlon <wylieconlon@gmail.com> * Update docs/user/dashboard/edit-dashboards.asciidoc Co-authored-by: Wylie Conlon <wylieconlon@gmail.com> * Update docs/user/dashboard/dashboard.asciidoc Co-authored-by: Wylie Conlon <wylieconlon@gmail.com> * Update docs/user/dashboard/dashboard.asciidoc Co-authored-by: Wylie Conlon <wylieconlon@gmail.com> * Update docs/user/dashboard/aggregation-reference.asciidoc Co-authored-by: Wylie Conlon <wylieconlon@gmail.com> * Review comments Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> Co-authored-by: Wylie Conlon <wylieconlon@gmail.com> # Conflicts: # docs/user/visualize.asciidoc # docs/visualize/heatmap.asciidoc
1 parent 19b212d commit 75b20b3

File tree

87 files changed

+2309
-2305
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

87 files changed

+2309
-2305
lines changed

docs/apm/apm-app-users.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Here are two examples:
8484
| Allow the use of the the {beat_kib_app}
8585

8686
| Spaces
87-
| `Read` or `All` on Dashboards, Visualize, and Discover
87+
| `Read` or `All` on Dashboards and Discover
8888
| Allow the user to view, edit, and create dashboards, as well as browse data.
8989
|====
9090

Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
[role="xpack"]
2+
[[add-canvas-elements]]
3+
=== Add elements
4+
5+
Create a story about your data by adding elements to your workpad that include images, text, charts, and more. You can create your own elements and connect them to your data sources, add saved objects, and add your own images.
6+
7+
[float]
8+
[[create-canvas-element]]
9+
==== Create an element
10+
11+
Choose the type of element you want to use, then connect it to your own data.
12+
13+
. Click *Add element*, then select the element you want to use.
14+
+
15+
[role="screenshot"]
16+
image::images/canvas-element-select.gif[Canvas elements]
17+
18+
. To familiarize yourself with the element, use the preconfigured data demo data.
19+
+
20+
By default, most of the elements you create use demo data until you change the data source. The demo data includes a small data set that you can use to experiment with your element.
21+
22+
. To connect the element to your data, select *Data*, then select one of the following data sources:
23+
24+
* *{es} SQL* &mdash; Access your data in {es} using SQL syntax. For information about SQL syntax, refer to {ref}/sql-spec.html[SQL language].
25+
26+
* *{es} documents* &mdash; Access your data in {es} without using aggregations. To use, select an index and fields, and optionally enter a query using the <<lucene-query,Lucene Query Syntax>>. Use the *{es} documents* data source when you have low volume datasets, to view raw documents, or to plot exact, non-aggregated values on a chart.
27+
28+
* *Timelion* &mdash; Access your time series data using <<timelion,Timelion>> queries. To use Timelion queries, you can enter a query using the <<lucene-query,Lucene Query Syntax>>.
29+
30+
Each element can display a different data source. Pages and workpads often contain multiple data sources.
31+
32+
[float]
33+
[[canvas-add-object]]
34+
==== Add a saved object
35+
36+
Add <<managing-saved-objects,saved objects>> to your workpad, such as maps and visualizations.
37+
38+
. Click *Add element > Add from Visualize Library*.
39+
40+
. Select the saved object you want to add.
41+
+
42+
[role="screenshot"]
43+
image::images/canvas-map-embed.gif[]
44+
45+
. To use the customization options, click the panel menu, then select one of the following options:
46+
47+
* *Edit map* &mdash; Opens <<maps,Maps>> or <<create-panels,Dashboard>> so that you can edit the original saved object.
48+
49+
* *Edit panel title* &mdash; Adds a title to the saved object.
50+
51+
* *Customize time range* &mdash; Exposes a time filter dedicated to the saved object.
52+
53+
* *Inspect* &mdash; Allows you to drill down into the element data.
54+
55+
[float]
56+
[[canvas-add-image]]
57+
==== Add your own image
58+
59+
To personalize your workpad, add your own logos and graphics.
60+
61+
. Click *Add element > Manage assets*.
62+
63+
. On the *Manage workpad assets* window, drag and drop your images.
64+
65+
. To add the image to the workpad, click the *Create image element* icon.
66+
+
67+
[role="screenshot"]
68+
image::images/canvas-add-image.gif[]
69+
70+
[float]
71+
[[move-canvas-elements]]
72+
==== Organize elements
73+
74+
Move and resize your elements to meet your design needs.
75+
76+
* To move, click and hold the element, then drag to the new location.
77+
78+
* To move by 1 pixel, select the element, press and hold Shift, then use your arrow keys.
79+
80+
* To move by 10 pixels, select the element, then use your arrow keys.
81+
82+
* To resize, click and drag the resize handles to the new dimensions.
83+
84+
[float]
85+
[[format-canvas-elements]]
86+
==== Format elements
87+
88+
For consistency and readability across your workpad pages, align, distribute, and reorder elements.
89+
90+
To align two or more elements:
91+
92+
. Press and hold Shift, then select the elements you want to align.
93+
94+
. Click *Edit > Alignment*, then select the alignment option.
95+
96+
To distribute three or more elements:
97+
98+
. Press and hold Shift, then select the elements you want to distribute.
99+
100+
. Click *Edit > Distribution*, then select the distribution option.
101+
102+
To reorder elements:
103+
104+
. Select the element you want to reorder.
105+
106+
. Click *Edit > Order*, then select the order option.
107+
108+
[float]
109+
[[data-display]]
110+
==== Change the element display options
111+
112+
Each element has its own display options to fit your design needs.
113+
114+
To choose the display options, click *Display*, then make your changes.
115+
116+
To define the appearance of the container and border:
117+
118+
. Next to *Element style*, click *+*, then select *Container style*.
119+
120+
. Expand *Container style*.
121+
122+
. Change the *Appearance* and *Border* options.
123+
124+
To apply CSS overrides:
125+
126+
. Next to *Element style*, click *+*, then select *CSS*.
127+
128+
. Enter the *CSS*.
129+
+
130+
For example, to center the Markdown element, enter:
131+
+
132+
[source,text]
133+
--------------------------------------------------
134+
.canvasRenderEl h1 {
135+
text.align: center;
136+
}
137+
--------------------------------------------------
138+
139+
. Click *Apply stylesheet*.
140+
141+
[float]
142+
[[save-elements]]
143+
==== Save elements
144+
145+
To use the elements across all workpads, save the elements.
146+
147+
When you're ready to save your element, select the element, then click *Edit > Save as new element*.
148+
149+
[role="screenshot"]
150+
image::images/canvas_save_element.png[]
151+
152+
To save a group of elements, press and hold Shift, select the elements you want to save, then click *Edit > Save as new element*.
153+
154+
To access your saved elements, click *Add element > My elements*.
155+
156+
[float]
157+
[[delete-elements]]
158+
==== Delete elements
159+
160+
When you no longer need an element, delete it from your workpad.
161+
162+
. Select the element you want to delete.
163+
164+
. Click *Edit > Delete*.
165+
+
166+
[role="screenshot"]
167+
image::images/canvas_element_options.png[]

docs/discover/search.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[[search]]
22
== Search data
33
Many Kibana apps embed a query bar for real-time search, including
4-
*Discover*, *Visualize*, and *Dashboard*.
4+
*Discover* and *Dashboard*.
55

66
[float]
77
=== Search your data
@@ -84,7 +84,7 @@ query language you can also submit queries using the {ref}/query-dsl.html[Elasti
8484

8585
[[save-open-search]]
8686
=== Save a search
87-
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 <<visualize, visualization>>.
87+
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.
8888

8989
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.
9090

@@ -120,7 +120,7 @@ used for the saved search will also be automatically selected.
120120

121121
[[save-load-delete-query]]
122122
=== Save a query
123-
A saved query is a portable collection of query text and filters that you can reuse in <<discover, Discover>>, <<visualize, Visualize>>, and <<dashboard, Dashboard>>. Save a query when you want to:
123+
A saved query is a portable collection of query text and filters that you can reuse in <<discover, Discover>> and <<dashboard, Dashboard>>. Save a query when you want to:
124124

125125
* Retrieve results from the same query at a later time without having to reenter the query text, add the filters or set the time filter
126126
* View the results of the same query in multiple apps
@@ -148,7 +148,7 @@ image::discover/images/saved-query-save-form-default-filters.png["Example of the
148148
. Click *Save*.
149149

150150
==== Load a query
151-
To load a saved query into Discover, Dashboard, or Visualize:
151+
To load a saved query into Discover or Dashboard:
152152

153153
. Click *#* in the search bar, next to the query text input.
154154
. Select the query you want to load. You might need to scroll down to find the query you are looking for.

docs/drilldowns/explore-underlying-data.asciidoc

Lines changed: 0 additions & 41 deletions
This file was deleted.

docs/getting-started/add-sample-data.asciidoc

Lines changed: 0 additions & 28 deletions
This file was deleted.
66.8 KB
Loading
151 KB
Loading

docs/getting-started/tutorial-dashboard.asciidoc

Lines changed: 0 additions & 53 deletions
This file was deleted.

0 commit comments

Comments
 (0)