Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Dashboard-first docs refresh #76194

Merged
merged 24 commits into from
Sep 3, 2020
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
99b56fd
[DOCS] Dashboard-first refresh
KOTungseth Aug 25, 2020
31b4134
Merge branch 'master' into docs/dashboard-refresh
KOTungseth Aug 27, 2020
d1f3998
Fixes broken links and partinto error
KOTungseth Aug 27, 2020
1d7e5e5
Fixes images in panel table
KOTungseth Aug 27, 2020
1aa4728
Fixes broken links
KOTungseth Aug 27, 2020
95dd351
Fixes broken drilldowns link
KOTungseth Aug 27, 2020
da82b81
Fixes images and table
KOTungseth Aug 31, 2020
0df55af
Removed un needed files and added edit content
KOTungseth Aug 31, 2020
dcc824d
Update docs/getting-started/tutorial-visualizing.asciidoc
KOTungseth Aug 31, 2020
d2bb346
Review comments
KOTungseth Sep 1, 2020
48403d3
Review comments
KOTungseth Sep 1, 2020
84fdb33
Review comment
KOTungseth Sep 2, 2020
b6b66f8
Removed blocks
KOTungseth Sep 3, 2020
6f0a2a0
Typo fix
KOTungseth Sep 3, 2020
229de23
Update docs/getting-started/tutorial-sample-data.asciidoc
KOTungseth Sep 3, 2020
0ef997c
Update docs/getting-started/tutorial-discovering.asciidoc
KOTungseth Sep 3, 2020
d3319c2
Update docs/getting-started/tutorial-sample-data.asciidoc
KOTungseth Sep 3, 2020
c610d6c
Update docs/getting-started/tutorial-visualizing.asciidoc
KOTungseth Sep 3, 2020
4a430d7
Update docs/user/dashboard/edit-dashboards.asciidoc
KOTungseth Sep 3, 2020
008b364
Update docs/user/dashboard/dashboard.asciidoc
KOTungseth Sep 3, 2020
3d6f366
Update docs/user/dashboard/dashboard.asciidoc
KOTungseth Sep 3, 2020
b6fe3ae
Update docs/user/dashboard/aggregation-reference.asciidoc
KOTungseth Sep 3, 2020
45ffaea
Review comments
KOTungseth Sep 3, 2020
e2b3c9d
Merge branch 'docs/dashboard-refresh' of https://github.com/KOTungset…
KOTungseth Sep 3, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/apm/apm-app-users.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Here are two examples:
| Allow the use of the the {beat_kib_app}

| Spaces
| `Read` or `All` on Dashboards, Visualize, and Discover
| `Read` or `All` on Dashboards and Discover
| Allow the user to view, edit, and create dashboards, as well as browse data.
|====

Expand Down
167 changes: 167 additions & 0 deletions docs/canvas/canvas-elements.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,167 @@
[role="xpack"]
[[add-canvas-elements]]
=== Add elements

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.

[float]
[[create-canvas-element]]
==== Create an element

Choose the type of element you want to use, then connect it to your own data.

. Click *Add element*, then select the element you want to use.
+
[role="screenshot"]
image::images/canvas-element-select.gif[Canvas elements]

. To familiarize yourself with the element, use the preconfigured data demo data.
+
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.

. To connect the element to your data, select *Data*, then select one of the following data sources:

* *{es} SQL* — Access your data in {es} using SQL syntax. For information about SQL syntax, refer to {ref}/sql-spec.html[SQL language].

* *{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.

* *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>>.

Each element can display a different data source. Pages and workpads often contain multiple data sources.

[float]
[[canvas-add-object]]
==== Add a saved object

Add <<managing-saved-objects,saved objects>> to your workpad, such as maps and visualizations.

. Click *Add element > Add from Visualize Library*.

. Select the saved object you want to add.
+
[role="screenshot"]
image::images/canvas-map-embed.gif[]

. To use the customization options, click the panel menu, then select one of the following options:

* *Edit map* &mdash; Opens <<maps,Maps>> or <<create-panels,Dashboard>> so that you can edit the original saved object.

* *Edit panel title* &mdash; Adds a title to the saved object.

* *Customize time range* &mdash; Exposes a time filter dedicated to the saved object.

* *Inspect* &mdash; Allows you to drill down into the element data.

[float]
[[canvas-add-image]]
==== Add your own image

To personalize your workpad, add your own logos and graphics.

. Click *Add element > Manage assets*.

. On the *Manage workpad assets* window, drag and drop your images.

. To add the image to the workpad, click the *Create image element* icon.
+
[role="screenshot"]
image::images/canvas-add-image.gif[]

[float]
[[move-canvas-elements]]
==== Organize elements

Move and resize your elements to meet your design needs.

* To move, click and hold the element, then drag to the new location.

* To move by 1 pixel, select the element, press and hold Shift, then use your arrow keys.

* To move by 10 pixels, select the element, then use your arrow keys.

* To resize, click and drag the resize handles to the new dimensions.

[float]
[[format-canvas-elements]]
==== Format elements

For consistency and readability across your workpad pages, align, distribute, and reorder elements.

To align two or more elements:

. Press and hold Shift, then select the elements you want to align.

. Click *Edit > Alignment*, then select the alignment option.

To distribute three or more elements:

. Press and hold Shift, then select the elements you want to distribute.

. Click *Edit > Distribution*, then select the distribution option.

To reorder elements:

. Select the element you want to reorder.

. Click *Edit > Order*, then select the order option.

[float]
[[data-display]]
==== Change the element display options

Each element has its own display options to fit your design needs.

To choose the display options, click *Display*, then make your changes.

To define the appearance of the container and border:

. Next to *Element style*, click *+*, then select *Container style*.

. Expand *Container style*.

. Change the *Appearance* and *Border* options.

To apply CSS overrides:

. Next to *Element style*, click *+*, then select *CSS*.

. Enter the *CSS*.
+
For example, to center the Markdown element, enter:
+
[source,text]
--------------------------------------------------
.canvasRenderEl h1 {
text.align: center;
}
--------------------------------------------------

. Click *Apply stylesheet*.

[float]
[[save-elements]]
==== Save elements

To use the elements across all workpads, save the elements.

When you're ready to save your element, select the element, then click *Edit > Save as new element*.

[role="screenshot"]
image::images/canvas_save_element.png[]

To save a group of elements, press and hold Shift, select the elements you want to save, then click *Edit > Save as new element*.

To access your saved elements, click *Add element > My elements*.

[float]
[[delete-elements]]
==== Delete elements

When you no longer need an element, delete it from your workpad.

. Select the element you want to delete.

. Click *Edit > Delete*.
+
[role="screenshot"]
image::images/canvas_element_options.png[]
8 changes: 4 additions & 4 deletions docs/discover/search.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[[search]]
== Search data
Many Kibana apps embed a query bar for real-time search, including
*Discover*, *Visualize*, and *Dashboard*.
*Discover* and *Dashboard*.

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

[[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 <<visualize, visualization>>.
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.

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.

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

[[save-load-delete-query]]
=== Save a query
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:
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:

* 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
* View the results of the same query in multiple apps
Expand Down Expand Up @@ -148,7 +148,7 @@ image::discover/images/saved-query-save-form-default-filters.png["Example of the
. Click *Save*.

==== Load a query
To load a saved query into Discover, Dashboard, or Visualize:
To load a saved query into Discover or Dashboard:

. Click *#* in the search bar, next to the query text input.
. Select the query you want to load. You might need to scroll down to find the query you are looking for.
Expand Down
41 changes: 0 additions & 41 deletions docs/drilldowns/explore-underlying-data.asciidoc

This file was deleted.

28 changes: 0 additions & 28 deletions docs/getting-started/add-sample-data.asciidoc

This file was deleted.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/getting-started/images/tutorial-discover-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/getting-started/images/tutorial-pattern-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/getting-started/images/tutorial-visualize-bar-1.5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/getting-started/images/tutorial-visualize-map-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/getting-started/images/tutorial-visualize-md-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/getting-started/images/tutorial-visualize-pie-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/getting-started/images/tutorial-visualize-pie-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
53 changes: 0 additions & 53 deletions docs/getting-started/tutorial-dashboard.asciidoc

This file was deleted.

Loading