Skip to content

Commit

Permalink
Merge remote-tracking branch upstream/master
Browse files Browse the repository at this point in the history
  • Loading branch information
YulNaumenko committed Mar 16, 2021
2 parents 5c1aca4 + d71e1b4 commit 749793c
Show file tree
Hide file tree
Showing 440 changed files with 8,151 additions and 2,941 deletions.
10 changes: 5 additions & 5 deletions docs/canvas/canvas-edit-workpads.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ each element instead of updating them manually.

For example, to change the index pattern for a set of charts:

Specify the variable options.

. Specify the variable options.
+
[role="screenshot"]
image::images/specify_variable_syntax.png[Image describing how to specify the variable syntax]

Copy the variable, then apply it to each element you want to update in the *Expression editor*.

+
. Copy the variable, then apply it to each element you want to update in the *Expression editor*.
+
[role="screenshot"]
image::images/copy_variable_syntax.png[Image demonstrating expression editor]

Expand Down
4 changes: 2 additions & 2 deletions docs/canvas/canvas-present-workpad.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ image::images/canvas-autoplay-interval.png[Element autoplay interval]
[role="screenshot"]
image::images/canvas-fullscreen.png[Image showing how to enter fullscreen mode from view dropdown]

. When you are ready to exit fullscreen mode, press the Esc (Escape) key.
. When you are ready to exit fullscreen mode, press Esc.

[float]
[[zoom-in-out]]
Expand Down Expand Up @@ -48,4 +48,4 @@ Change how often the data refreshes on your workpad.
[role="screenshot"]
image::images/canvas-refresh-interval.png[Element data refresh interval]
+
To manually refresh the data, click image:canvas/images/canvas-refresh-data.png[].
To manually refresh the data, click image:canvas/images/canvas-refresh-data.png[Canvas refresh data button].
4 changes: 2 additions & 2 deletions docs/canvas/canvas-share-workpad.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Want to export multiple workpads? Go to the *Canvas* home page, select the workp
[[add-workpad-website]]
=== Share the workpad on a website

beta[] Canvas allows you to create _shareables_, which are workpads that you download and securely share on any website.
beta[] *Canvas* allows you to create _shareables_, which are workpads that you download and securely share on any website.
To customize the behavior of the workpad on your website, you can choose to autoplay the pages or hide the workpad toolbar.

. Click *Share > Share on a website*.
Expand All @@ -32,7 +32,7 @@ To customize the behavior of the workpad on your website, you can choose to auto

. To customize the workpad behavior to autoplay the pages or hide the toolbar, use the inline parameters.
+
To make sure that your data remains secure, the data in the JSON file is not connected to {kib}. Canvas does not display elements that manipulate the data on the workpad.
To make sure that your data remains secure, the data in the JSON file is not connected to {kib}. *Canvas* does not display elements that manipulate the data on the workpad.
+
[role="screenshot"]
image::canvas/images/canvas-embed_workpad.gif[Image showing how to share the workpad on a website]
Expand Down
17 changes: 8 additions & 9 deletions docs/canvas/canvas-tutorial.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,16 @@
[[canvas-tutorial]]
== Tutorial: Create a workpad for monitoring sales

To get up and running with Canvas, add the Sample eCommerce orders data, then use the data to create a workpad for monitoring sales at an eCommerce store.
To familiarize yourself with *Canvas*, add the Sample eCommerce orders data, then use the data to create a workpad for monitoring sales at an eCommerce store.

[float]
=== Before you begin
=== Open and set up Canvas

For this tutorial, you'll need to add the <<add-sample-data, Sample eCommerce orders data>>.
To create a workpad of the eCommerce store data, add the data set, then create the workpad.

[float]
=== Create your workpad
. On the {kib} *Home* page, click *Try our sample data*.

Your first step to working with Canvas is to create a workpad.
. From *Sample eCommerce orders data*, click *Add data*.

. Open the main menu, then click *Canvas*.

Expand Down Expand Up @@ -59,7 +58,7 @@ The query selects the total price field and sets it to the sum_total_price field

.. Change the *Label* to `Total sales`.

. The error is gone, but the element could use some formatting. To format the number, use the Canvas expression language.
. The error is gone, but the element could use some formatting. To format the number, use the *Canvas* expression language.

.. Click *Expression editor*.
+
Expand Down Expand Up @@ -118,12 +117,12 @@ Your workpad is complete!

[float]
=== What's next?
Now that you know the Canvas basics, you're ready to explore on your own.
Now that you know the basics, you're ready to explore on your own.

Here are some things to try:

* Play with the {kibana-ref}/add-sample-data.html[sample Canvas workpads].

* Build presentations of your own data with <<create-workpads,workpads>>.

* Deep dive into the {kibana-ref}/canvas-function-reference.html[expression language and functions] that drive Canvas.
* Deep dive into the {kibana-ref}/canvas-function-reference.html[expression language and functions] that drive *Canvas*.
Binary file modified docs/canvas/images/canvas-gs-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IScopedSearchClient](./kibana-plugin-plugins-data-server.iscopedsearchclient.md) &gt; [cancelSession](./kibana-plugin-plugins-data-server.iscopedsearchclient.cancelsession.md)

## IScopedSearchClient.cancelSession property

<b>Signature:</b>

```typescript
cancelSession: IScopedSearchSessionsClient['cancel'];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IScopedSearchClient](./kibana-plugin-plugins-data-server.iscopedsearchclient.md) &gt; [deleteSession](./kibana-plugin-plugins-data-server.iscopedsearchclient.deletesession.md)

## IScopedSearchClient.deleteSession property

<b>Signature:</b>

```typescript
deleteSession: IScopedSearchSessionsClient['delete'];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IScopedSearchClient](./kibana-plugin-plugins-data-server.iscopedsearchclient.md) &gt; [extendSession](./kibana-plugin-plugins-data-server.iscopedsearchclient.extendsession.md)

## IScopedSearchClient.extendSession property

<b>Signature:</b>

```typescript
extendSession: IScopedSearchSessionsClient['extend'];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IScopedSearchClient](./kibana-plugin-plugins-data-server.iscopedsearchclient.md) &gt; [findSessions](./kibana-plugin-plugins-data-server.iscopedsearchclient.findsessions.md)

## IScopedSearchClient.findSessions property

<b>Signature:</b>

```typescript
findSessions: IScopedSearchSessionsClient['find'];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IScopedSearchClient](./kibana-plugin-plugins-data-server.iscopedsearchclient.md) &gt; [getSession](./kibana-plugin-plugins-data-server.iscopedsearchclient.getsession.md)

## IScopedSearchClient.getSession property

<b>Signature:</b>

```typescript
getSession: IScopedSearchSessionsClient['get'];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IScopedSearchClient](./kibana-plugin-plugins-data-server.iscopedsearchclient.md)

## IScopedSearchClient interface

<b>Signature:</b>

```typescript
export interface IScopedSearchClient extends ISearchClient
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [cancelSession](./kibana-plugin-plugins-data-server.iscopedsearchclient.cancelsession.md) | <code>IScopedSearchSessionsClient['cancel']</code> | |
| [deleteSession](./kibana-plugin-plugins-data-server.iscopedsearchclient.deletesession.md) | <code>IScopedSearchSessionsClient['delete']</code> | |
| [extendSession](./kibana-plugin-plugins-data-server.iscopedsearchclient.extendsession.md) | <code>IScopedSearchSessionsClient['extend']</code> | |
| [findSessions](./kibana-plugin-plugins-data-server.iscopedsearchclient.findsessions.md) | <code>IScopedSearchSessionsClient['find']</code> | |
| [getSession](./kibana-plugin-plugins-data-server.iscopedsearchclient.getsession.md) | <code>IScopedSearchSessionsClient['get']</code> | |
| [saveSession](./kibana-plugin-plugins-data-server.iscopedsearchclient.savesession.md) | <code>IScopedSearchSessionsClient['save']</code> | |
| [updateSession](./kibana-plugin-plugins-data-server.iscopedsearchclient.updatesession.md) | <code>IScopedSearchSessionsClient['update']</code> | |
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IScopedSearchClient](./kibana-plugin-plugins-data-server.iscopedsearchclient.md) &gt; [saveSession](./kibana-plugin-plugins-data-server.iscopedsearchclient.savesession.md)

## IScopedSearchClient.saveSession property

<b>Signature:</b>

```typescript
saveSession: IScopedSearchSessionsClient['save'];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IScopedSearchClient](./kibana-plugin-plugins-data-server.iscopedsearchclient.md) &gt; [updateSession](./kibana-plugin-plugins-data-server.iscopedsearchclient.updatesession.md)

## IScopedSearchClient.updateSession property

<b>Signature:</b>

```typescript
updateSession: IScopedSearchSessionsClient['update'];
```
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
| [IFieldSubType](./kibana-plugin-plugins-data-server.ifieldsubtype.md) | |
| [IFieldType](./kibana-plugin-plugins-data-server.ifieldtype.md) | |
| [IndexPatternAttributes](./kibana-plugin-plugins-data-server.indexpatternattributes.md) | Interface for an index pattern saved object |
| [IScopedSearchClient](./kibana-plugin-plugins-data-server.iscopedsearchclient.md) | |
| [ISearchOptions](./kibana-plugin-plugins-data-server.isearchoptions.md) | |
| [ISearchSessionService](./kibana-plugin-plugins-data-server.isearchsessionservice.md) | |
| [ISearchSetup](./kibana-plugin-plugins-data-server.isearchsetup.md) | |
Expand Down
44 changes: 24 additions & 20 deletions docs/glossary.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[[glossary]]
= Glossary

<<a_glos>> | <<b_glos>> | <<c_glos>> | <<d_glos>> | <<e_glos>> | <<f_glos>> | <<g_glos>> | H | I | J | <<k_glos>> | <<l_glos>> | <<m_glos>> | N | O | <<p_glos>> | <<q_glos>> | R | <<s_glos>> | <<t_glos>> | <<u_glos>> | V | <<w_glos>> | X | Y | Z
<<a_glos>> | <<b_glos>> | <<c_glos>> | <<d_glos>> | <<e_glos>> | <<f_glos>> | <<g_glos>> | H | I | J | <<k_glos>> | <<l_glos>> | <<m_glos>> | N | O | <<p_glos>> | <<q_glos>> | <<r_glos>> | <<s_glos>> | <<t_glos>> | <<u_glos>> | V | <<w_glos>> | X | Y | Z

[float]
[[a_glos]]
Expand All @@ -13,10 +13,10 @@
+
--
// tag::action-def[]
The alert-specific response that occurs when an alert fires.
An alert can have multiple actions.
The rule-specific response that occurs when an alerting rule fires.
A rule can have multiple actions.
See
{kibana-ref}/action-types.html[Action and connector types].
{kibana-ref}/action-types.html[Connectors and actions].
// end::action-def[]
--

Expand All @@ -28,20 +28,6 @@ Part of {kib} Stack Management.
See {kibana-ref}/advanced-options.html[Advanced Settings].
// end::advanced-settings-def[]

[[glossary-alert]] alert ::
// tag::alert-def[]
A set of <<glossary-condition,conditions>>, schedules, and <<glossary-action,actions>>
that enable notifications.
See <<glossary-alerts-and-actions,Alerts and Actions>>.
// end::alert-def[]

[[glossary-alerts-and-actions]] Alerts and Actions ::
// tag::alerts-and-actions-def[]
A comprehensive view of all your alerts. Enables you to access and
manage alerts for all {kib} apps from one place.
See {kibana-ref}/alerting-getting-started.html[Alerts and Actions].
// end::alerts-and-actions-def[]

[[glossary-annotation]] annotation ::
// tag::annotation-def[]
A way to augment a data display with descriptive domain knowledge.
Expand Down Expand Up @@ -113,13 +99,13 @@ The cluster location is the weighted centroid for all documents in the grid cell

[[glossary-condition]] condition ::
// tag::condition-def[]
Specifies the circumstances that must be met to trigger an alert.
Specifies the circumstances that must be met to trigger an alerting rule.
// end::condition-def[]

[[glossary-connector]] connector ::
// tag::connector-def[]
A configuration that enables integration with an external system (the destination for an action).
See {kibana-ref}/action-types.html[Action and connector types].
See {kibana-ref}/action-types.html[Connectors and actions].
// end::connector-def[]

[[glossary-console]] Console ::
Expand Down Expand Up @@ -335,6 +321,24 @@ A tool that enables you to inspect and analyze search queries to diagnose and de
See {kibana-ref}/xpack-profiler.html[Query Profiler].
// end::query-profiler-def[]

[float]
[[r_glos]]
== R

[[glossary-rule]] rule ::
// tag::rule-def[]
A set of <<glossary-condition,conditions>>, schedules, and <<glossary-action,actions>>
that enable notifications.
See <<glossary-rules-and-connectors,Rules and Connectors>>.
// end::rule-def[]

[[glossary-rules-and-connectors]] Rules and Connectors ::
// tag::rules-and-connectors-def[]
A comprehensive view of all your alerting rules. Enables you to access and
manage rules for all {kib} apps from one place.
See {kibana-ref}/alerting-getting-started.html[Rules and Connectors].
// end::rules-and-connectors-def[]

[float]
[[s_glos]]
== S
Expand Down
8 changes: 8 additions & 0 deletions docs/migration/migrate_8_0.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -202,5 +202,13 @@ All supported operating systems support using systemd service files. Any system
*Impact:*
Any installations using `.deb` or `.rpm` packages using SysV will need to migrate to systemd.

[float]
=== Platform removed from root folder name for `.tar.gz` and `.zip` archives

*Details:*
The output directory after extracting an archive no longer includes the target platform. For example, `kibana-8.0.0-linux-aarch64.tar.gz` will produce a folder named `kibana-8.0.0`.

*Impact:*
Configuration management tools and automation will need to be updated to use the new directory.

// end::notable-breaking-changes[]
4 changes: 2 additions & 2 deletions docs/setup/install/targz.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The Linux archive for Kibana v{version} can be downloaded and installed as follo
curl -O https://artifacts.elastic.co/downloads/kibana/kibana-{version}-linux-x86_64.tar.gz
curl https://artifacts.elastic.co/downloads/kibana/kibana-{version}-linux-x86_64.tar.gz.sha512 | shasum -a 512 -c - <1>
tar -xzf kibana-{version}-linux-x86_64.tar.gz
cd kibana-{version}-linux-x86_64/ <2>
cd kibana-{version}/ <2>
--------------------------------------------
<1> Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output
`kibana-{version}-linux-x86_64.tar.gz: OK`.
Expand Down Expand Up @@ -82,7 +82,7 @@ The Darwin archive for Kibana v{version} can be downloaded and installed as foll
curl -O https://artifacts.elastic.co/downloads/kibana/kibana-{version}-darwin-x86_64.tar.gz
curl https://artifacts.elastic.co/downloads/kibana/kibana-{version}-darwin-x86_64.tar.gz.sha512 | shasum -a 512 -c - <1>
tar -xzf kibana-{version}-darwin-x86_64.tar.gz
cd kibana-{version}-darwin-x86_64/ <2>
cd kibana-{version}/ <2>
--------------------------------------------
<1> Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output
`kibana-{version}-darwin-x86_64.tar.gz: OK`.
Expand Down
Loading

0 comments on commit 749793c

Please sign in to comment.