Merge branch 'master' of github.com:elastic/kibana into implement/obs…

…ervable-helpers
elastic · Oct 8, 2020 · 1e94a61 · 1e94a61
2 parents b5fb731 + a8b5e9f
commit 1e94a61
Show file tree

Hide file tree

Showing 126 changed files with 1,710 additions and 1,098 deletions.
diff --git a/docs/canvas/canvas-share-workpad.asciidoc b/docs/canvas/canvas-share-workpad.asciidoc
@@ -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]
@@ -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]
@@ -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]

diff --git a/docs/canvas/canvas-tutorial.asciidoc b/docs/canvas/canvas-tutorial.asciidoc
@@ -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
@@ -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.
diff --git a/docs/canvas/images/canvas-autoplay-interval.png b/docs/canvas/images/canvas-autoplay-interval.png
diff --git a/docs/canvas/images/canvas-gs-example.png b/docs/canvas/images/canvas-gs-example.png
diff --git a/docs/canvas/images/canvas-refresh-interval.png b/docs/canvas/images/canvas-refresh-interval.png
diff --git a/docs/canvas/images/canvas-zoom-controls.png b/docs/canvas/images/canvas-zoom-controls.png
diff --git a/docs/developer/contributing/development-documentation.asciidoc b/docs/developer/contributing/development-documentation.asciidoc
@@ -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

diff --git a/docs/getting-started/images/add-sample-data.png b/docs/getting-started/images/add-sample-data.png
diff --git a/docs/getting-started/images/gs_maps_time_filter.png b/docs/getting-started/images/gs_maps_time_filter.png
diff --git a/docs/getting-started/images/tutorial-dashboard.png b/docs/getting-started/images/tutorial-dashboard.png
diff --git a/docs/getting-started/images/tutorial-discover-2.png b/docs/getting-started/images/tutorial-discover-2.png
diff --git a/docs/getting-started/images/tutorial-discover-3.png b/docs/getting-started/images/tutorial-discover-3.png
diff --git a/docs/getting-started/images/tutorial-discover-4.png b/docs/getting-started/images/tutorial-discover-4.png
diff --git a/docs/getting-started/images/tutorial-final-dashboard.gif b/docs/getting-started/images/tutorial-final-dashboard.gif
diff --git a/docs/getting-started/images/tutorial-full-inspect1.png b/docs/getting-started/images/tutorial-full-inspect1.png
diff --git a/docs/getting-started/images/tutorial-pattern-1.png b/docs/getting-started/images/tutorial-pattern-1.png
diff --git a/docs/getting-started/images/tutorial-sample-dashboard.png b/docs/getting-started/images/tutorial-sample-dashboard.png
diff --git a/docs/getting-started/images/tutorial-sample-discover1.png b/docs/getting-started/images/tutorial-sample-discover1.png
diff --git a/docs/getting-started/images/tutorial-sample-discover2.png b/docs/getting-started/images/tutorial-sample-discover2.png
diff --git a/docs/getting-started/images/tutorial-sample-edit1.png b/docs/getting-started/images/tutorial-sample-edit1.png
diff --git a/docs/getting-started/images/tutorial-sample-edit2.png b/docs/getting-started/images/tutorial-sample-edit2.png
diff --git a/docs/getting-started/images/tutorial-sample-filter.png b/docs/getting-started/images/tutorial-sample-filter.png
diff --git a/docs/getting-started/images/tutorial-sample-filter2.png b/docs/getting-started/images/tutorial-sample-filter2.png
diff --git a/docs/getting-started/images/tutorial-sample-inspect1.png b/docs/getting-started/images/tutorial-sample-inspect1.png
diff --git a/docs/getting-started/images/tutorial-sample-query.png b/docs/getting-started/images/tutorial-sample-query.png
diff --git a/docs/getting-started/images/tutorial-sample-query2.png b/docs/getting-started/images/tutorial-sample-query2.png
diff --git a/docs/getting-started/images/tutorial-treemap.png b/docs/getting-started/images/tutorial-treemap.png
diff --git a/docs/getting-started/images/tutorial-visualization-dropdown.png b/docs/getting-started/images/tutorial-visualization-dropdown.png
diff --git a/docs/getting-started/images/tutorial-visualize-bar-1.5.png b/docs/getting-started/images/tutorial-visualize-bar-1.5.png
diff --git a/docs/getting-started/images/tutorial-visualize-map-2.png b/docs/getting-started/images/tutorial-visualize-map-2.png
diff --git a/docs/getting-started/images/tutorial-visualize-md-2.png b/docs/getting-started/images/tutorial-visualize-md-2.png
diff --git a/docs/getting-started/images/tutorial-visualize-pie-2.png b/docs/getting-started/images/tutorial-visualize-pie-2.png
diff --git a/docs/getting-started/images/tutorial-visualize-pie-3.png b/docs/getting-started/images/tutorial-visualize-pie-3.png
diff --git a/docs/getting-started/images/tutorial-visualize-wizard-step-1.png b/docs/getting-started/images/tutorial-visualize-wizard-step-1.png
diff --git a/docs/getting-started/images/tutorial_index_patterns.png b/docs/getting-started/images/tutorial_index_patterns.png
diff --git a/docs/getting-started/quick-start-guide.asciidoc b/docs/getting-started/quick-start-guide.asciidoc
@@ -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].
diff --git a/docs/getting-started/tutorial-define-index.asciidoc b/docs/getting-started/tutorial-define-index.asciidoc
diff --git a/docs/getting-started/tutorial-discovering.asciidoc b/docs/getting-started/tutorial-discovering.asciidoc