Skip to content

Commit

Permalink
Merge branch 'master' into resolver/pills-compact-notation
Browse files Browse the repository at this point in the history
  • Loading branch information
kibanamachine committed Oct 8, 2020
2 parents 9641856 + a8b5e9f commit e067ca9
Show file tree
Hide file tree
Showing 445 changed files with 10,707 additions and 4,009 deletions.
3 changes: 2 additions & 1 deletion .backportrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"targetBranchChoices": [
{ "name": "master", "checked": true },
{ "name": "7.x", "checked": true },
"7.10",
"7.9",
"7.8",
"7.7",
Expand All @@ -27,7 +28,7 @@
"targetPRLabels": ["backport"],
"branchLabelMapping": {
"^v8.0.0$": "master",
"^v7.10.0$": "7.x",
"^v7.11.0$": "7.x",
"^v(\\d+).(\\d+).\\d+$": "$1.$2"
}
}
5 changes: 3 additions & 2 deletions docs/api/saved-objects/bulk_create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,9 @@ experimental[] Create multiple {kib} saved objects.
(Optional, array) Objects with `name`, `id`, and `type` properties that describe the other saved objects in the referenced object. To refer to the other saved object, use `name` in the attributes. Never use `id` to refer to the other saved object. `id` can be automatically updated during migrations, import, or export.

`initialNamespaces`::
(Optional, string array) Identifiers for the <<xpack-spaces,spaces>> in which this object should be created. If this is not provided, the
object will be created in the current space.
(Optional, string array) Identifiers for the <<xpack-spaces,spaces>> in which this object is created. If this is provided, the
object is created only in the explicitly defined spaces. If this is not provided, the object is created in the current space
(default behavior).

`version`::
(Optional, number) Specifies the version.
Expand Down
5 changes: 3 additions & 2 deletions docs/api/saved-objects/create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,9 @@ any data that you send to the API is properly formed.
(Optional, array) Objects with `name`, `id`, and `type` properties that describe the other saved objects that this object references. Use `name` in attributes to refer to the other saved object, but never the `id`, which can update automatically during migrations or import/export.

`initialNamespaces`::
(Optional, string array) Identifiers for the <<xpack-spaces,spaces>> in which this object should be created. If this is not provided, the
object will be created in the current space.
(Optional, string array) Identifiers for the <<xpack-spaces,spaces>> in which this object is created. If this is provided, the
object is created only in the explicitly defined spaces. If this is not provided, the object is created in the current space
(default behavior).

[[saved-objects-api-create-request-codes]]
==== Response code
Expand Down
6 changes: 3 additions & 3 deletions docs/canvas/canvas-share-workpad.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ When you've finished your workpad, you can share it outside of {kib}.

Create a JSON file of your workpad that you can export outside of {kib}.

Click *Share > Download as JSON*.
To begin, click *Share > Download as JSON*.

[role="screenshot"]
image::images/canvas-export-workpad.png[Export single workpad through JSON, from Share dropdown]
Expand All @@ -23,7 +23,7 @@ Want to export multiple workpads? Go to the *Canvas* home page, select the workp

If you have a subscription that supports the {report-features}, you can create a PDF copy of your workpad that you can save and share outside {kib}.

Click *Share > PDF reports > Generate PDF*.
To begin, click *Share > PDF reports > Generate PDF*.

[role="screenshot"]
image::images/canvas-generate-pdf.gif[Image showing how to generate a PDF]
Expand All @@ -36,7 +36,7 @@ For more information, refer to <<reporting-getting-started, Reporting from Kiban

If you have a subscription that supports the {report-features}, you can create a POST URL that you can use to automatically generate PDF reports using <<watcher-ui,Watcher>> or a script.

Click *Share > PDF reports > Copy POST URL*.
To begin, click *Share > PDF reports > Copy POST URL*.

[role="screenshot"]
image::images/canvas-create-URL.gif[Image showing how to create POST URL]
Expand Down
10 changes: 4 additions & 6 deletions docs/canvas/canvas-tutorial.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[[canvas-tutorial]]
== Tutorial: Create a workpad for monitoring sales

To get up and running with Canvas, use the following tutorial where you'll create a workpad for monitoring sales at an eCommerce store.
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.

[float]
=== Before you begin
Expand Down Expand Up @@ -114,18 +114,16 @@ image::images/canvas-timefilter-element.png[Image showing Canvas workpad with fi

To see how the data changes, set the time filter to *Last 7 days*. As you change the time filter options, the elements automatically update.

Your workpad is now complete!
Your workpad is complete!

[float]
=== Next steps
=== What's next?
Now that you know the Canvas 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 live data with <<create-workpads,workpads>>.

* Learn more about <<add-canvas-elements,elements>> &mdash; the building blocks of your workpad.
* 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.
Binary file modified docs/canvas/images/canvas-autoplay-interval.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/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.
Binary file modified docs/canvas/images/canvas-refresh-interval.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/canvas/images/canvas-zoom-controls.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
Expand Up @@ -26,6 +26,13 @@ README for getting the docs tooling set up.
```bash
node scripts/docs.js --open
```
[discrete]
==== REST APIs

REST APIs should be documented using the following recommended formats:

* https://raw.githubusercontent.com/elastic/docs/master/shared/api-ref-ex.asciidoc[API doc templaate]
* https://raw.githubusercontent.com/elastic/docs/master/shared/api-definitions-ex.asciidoc[API object definition template]

[discrete]
=== General developer documentation and guidelines
Expand Down
2 changes: 1 addition & 1 deletion docs/developer/contributing/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The Release Notes summarize what the PRs accomplish in language that is meaningf

The text that appears in the Release Notes is pulled directly from your PR title, or a single paragraph of text that you specify in the PR description.

To use a single paragraph of text, enter `Release note:` or a `## Release note` header in the PR description, followed by your text. For example, refer to this https://github.com/elastic/kibana/pull/65796[PR] that uses the `## Release note` header.
To use a single paragraph of text, enter a `Release note:` or `## Release note` header in the PR description ("dev docs" works too), followed by your text. For example, refer to this https://github.com/elastic/kibana/pull/65796[PR] that uses the `## Release note` header.

When you create the Release Notes text, use the following best practices:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
<b>Signature:</b>

```typescript
export declare type IndexPatternSelectProps = Required<Omit<EuiComboBoxProps<any>, 'isLoading' | 'onSearchChange' | 'options' | 'selectedOptions'>, 'onChange' | 'placeholder'> & {
export declare type IndexPatternSelectProps = Required<Omit<EuiComboBoxProps<any>, 'isLoading' | 'onSearchChange' | 'options' | 'selectedOptions' | 'onChange'>, 'placeholder'> & {
onChange: (indexPatternId?: string) => void;
indexPatternId: string;
fieldTypes?: string[];
onNoIndexPatterns?: () => void;
savedObjectsClient: SavedObjectsClientContract;
};
```
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[chapter]
[role="xpack"]
[[ingest-manager]]
= {ingest-manager}
[[fleet]]
= {fleet}

experimental[]

{ingest-manager} in {kib} enables you to add and manage integrations for popular
{fleet} in {kib} enables you to add and manage integrations for popular
services and platforms, as well as manage {elastic-agent} installations in
standalone or {fleet} mode.

Expand All @@ -17,11 +17,13 @@ Standalone mode requires you to manually configure and manage the agent locally.
* An overview of the data ingest in your {es} cluster.
* Multiple integrations to collect and transform data.

//TODO: Redo screen capture.

[role="screenshot"]
image::ingest_manager/images/ingest-manager-start.png[{ingest-manager} app in {kib}]
image::fleet/images/fleet-start.png[{fleet} app in {kib}]

[float]
== Get started

To get started with {ingest-management}, refer to the
To get started with {fleet}, refer to the
{ingest-guide}/index.html[Ingest Management Guide].
Binary file added docs/fleet/images/fleet-start.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/add-sample-data.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 removed docs/getting-started/images/gs_maps_time_filter.png
Binary file not shown.
Binary file removed docs/getting-started/images/tutorial-dashboard.png
Binary file not shown.
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-discover-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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file removed docs/getting-started/images/tutorial-pattern-1.png
Binary file not shown.
Binary file modified docs/getting-started/images/tutorial-sample-dashboard.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 not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/getting-started/images/tutorial-sample-filter.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.
Binary file not shown.
Binary file modified docs/getting-started/images/tutorial-sample-query.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.
Binary file added docs/getting-started/images/tutorial-treemap.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
142 changes: 142 additions & 0 deletions docs/getting-started/quick-start-guide.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
[[get-started]]
== Quick start

To quickly get up and running with {kib}, set up on Cloud, then add a sample data set that you can explore and analyze.

When you've finished, you'll know how to:

* <<explore-the-data,Explore the data with *Discover*.>>

* <<view-and-analyze-the-data,Gain insight into the data with *Dashboard*.>>

[float]
=== Before you begin
When security is enabled, you must have `read`, `write`, and `manage` privileges on the `kibana_sample_data_*` indices. For more information, refer to {ref}/security-privileges.html[Security privileges].

[float]
[[set-up-on-cloud]]
== Set up on cloud

include::{docs-root}/shared/cloud/ess-getting-started.asciidoc[]

[float]
[[gs-get-data-into-kibana]]
== Add the sample data

Sample data sets come with sample visualizations, dashboards, and more to help you explore {kib} without adding your own data.

. From the home page, click *Try our sample data*.

. On the *Sample eCommerce orders* card, click *Add data*.
+
[role="screenshot"]
image::getting-started/images/add-sample-data.png[]

[float]
[[explore-the-data]]
== Explore the data

*Discover* displays an interactive histogram that shows the distribution of of data, or documents, over time, and a table that lists the fields for each document that matches the index. By default, all fields are shown for each matching document.

. Open the menu, then click *Discover*.

. Change the <<set-time-filter, time filter>> to *Last 7 days*.
+
[role="screenshot"]
image::images/tutorial-discover-2.png[]

. To focus in on the documents you want to view, use the <<kuery-query,{kib} Query Language>>. In the *KQL* search field, enter:
+
[source,text]
products.taxless_price >= 60 AND category : Women's Clothing
+
The query returns the women's clothing orders for $60 and more.
+
[role="screenshot"]
image::images/tutorial-discover-4.png[]

. Hover over the list of *Available fields*, then click *+* next to the fields you want to view in the table.
+
For example, when you add the *category* field, the table displays the product categories for the orders.
+
[role="screenshot"]
image::images/tutorial-discover-3.png[]
+
For more information, refer to <<discover, *Discover*>>.

[float]
[[view-and-analyze-the-data]]
== View and analyze the data

A dashboard is a collection of panels that you can use to view and analyze the data. Panels contain visualizations, interactive controls, Markdown, and more.

. Open the menu, then click *Dashboard*.

. Click *[eCommerce] Revenue Dashboard*.
+
[role="screenshot"]
image::getting-started/images/tutorial-sample-dashboard.png[]

[float]
[[filter-and-query-the-data]]
=== Filter the data

To focus in on the data you want to view on the dashboard, use filters.

. From the *Controls* visualization, make a selection from the *Manufacturer* and *Category* dropdowns, then click *Apply changes*.
+
For example, the following dashboard shows the data for women's clothing from Gnomehouse.
+
[role="screenshot"]
image::getting-started/images/tutorial-sample-filter.png[]

. To manually add a filter, click *Add filter*, then specify the options.
+
For example, to view the orders for Wednesday, select *day_of_week* from the *Field* dropdown, select *is* from the *Operator* dropdown, then select *Wednesday* from the *Value* dropdown.
+
[role="screenshot"]
image::getting-started/images/tutorial-sample-filter2.png[]

. When you are done, remove the filters.
+
For more information, refer to <<dashboard,*Dashboard*>>.

[float]
[[create-a-visualization]]
=== Create a visualization

To create a treemap that shows the top regions and manufacturers, use *Lens*, then add the treemap to the dashboard.

. From the {kib} toolbar, click *Edit*, then click *Create new*.

. On the *New Visualization* window, click *Lens*.

. From the *Available fields* list, drag and drop the following fields to the visualization builder:

* *geoip.city_name*

* *manufacturer.keyword*
+
. From the visualization dropdown, select *Treemap*.
+
[role="screenshot"]
image::getting-started/images/tutorial-visualization-dropdown.png[Visualization dropdown with Treemap selected]

. Click *Save*.

. On the *Save Lens visualization*, enter a title and make sure *Add to Dashboard after saving* is selected, then click *Save and return*.
+
The treemap appears as the last visualization on the dashboard.
+
[role="screenshot"]
image::getting-started/images/tutorial-final-dashboard.gif[Final dashboard with new treemap visualization]
+
For more information, refer to <<lens, *Lens*>>.

[float]
[[quick-start-whats-next]]
== What's next?

If you are you ready to add your own data, refer to <<connect-to-elasticsearch,Add data to {kib}>>.

If you want to ingest your data, refer to {ingest-guide}/ingest-management-getting-started.html[Quick start: Get logs and metrics into the Elastic Stack].
56 changes: 0 additions & 56 deletions docs/getting-started/tutorial-define-index.asciidoc

This file was deleted.

Loading

0 comments on commit e067ca9

Please sign in to comment.