Skip to content
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
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
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.
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.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Diff not rendered.
135 changes: 135 additions & 0 deletions docs/getting-started/quick-start-guide.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
[[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 use to explore and analyze.

[float]
=== Required privileges
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of "Required privileges", could this be "Before you begin" with two links

  • Some text about knowing what Kibana is for and linking to What is Kibana? Or is that too deep?
  • Have these privileges....

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed this Before your begin, but the rule of thumb is that you don't need to link out to topics that are within 3-5 topics.

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[]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do you feel about making "Click Launch Kibana" step 6? We could talk to the Cloud folks about changing the include file.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can go either way. This topic is about how to set up on Cloud, not how to launch Kibana. So I can see why the Kibana-specific content comes after the tasks. On the other hand, it is a task, so it really should appear as one. I'll leave this one up to you.


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

. Go to 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]]
[[query-the-data]]
== Explore the data

With *Discover*, use {ref}/query-dsl-query-string-query.html#query-string-syntax[Elasticsearch
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As this is a beginning tutorial, should there be more context around indices and fields?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Context around indices and fields should be covered before this tutorial. I don't want to muck this up with a bunch of words -- this should be short and concise.

queries] and filters to explore your 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

Gain insight into your data with *Dashboard*, which is a collection of panels that you can
use to view and analyze your 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

Use *Lens* to create a treemap that shows the top regions and manufacturersthen, then add it 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*
+
[role="screenshot"]
image::getting-started/images/tutorial-treemap.png[Treemap in Lens that shows the top regions and manufacturers from the Ecommerce sample data]

. Click *Save, enter a title, then click *Save and return*.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Too much bold in this step.

Does the visualization automatically appear on the dashboard?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there somewhere that states how much bold it too much bold? I wasn't aware of this rule.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't "enter a title, then click" be in regular font?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Face palm

+
For more information, refer to <<lens, *Lens*>>.

[float]
[[quick-start-next-steps]]
== Next steps

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "Add Data" needs updating. I'll add it to my ToDo list.


If you want to ingest your data, refer to <<ingest-manager, Ingest Manager>>.
56 changes: 0 additions & 56 deletions docs/getting-started/tutorial-define-index.asciidoc

This file was deleted.

35 changes: 0 additions & 35 deletions docs/getting-started/tutorial-discovering.asciidoc

This file was deleted.

Loading