From de2f1d94b586ab22954dcf0861d24cc1141e562f Mon Sep 17 00:00:00 2001 From: KOTungseth Date: Fri, 21 Feb 2020 13:01:04 -0600 Subject: [PATCH 1/4] [DOCS] Rework of main gett started page --- docs/user/getting-started.asciidoc | 74 +++++++++++++++++------------- docs/user/index.asciidoc | 4 +- 2 files changed, 44 insertions(+), 34 deletions(-) diff --git a/docs/user/getting-started.asciidoc b/docs/user/getting-started.asciidoc index 4d74ca16683273..f69498ecca24b1 100644 --- a/docs/user/getting-started.asciidoc +++ b/docs/user/getting-started.asciidoc @@ -1,55 +1,66 @@ [[getting-started]] -= Getting Started += Get started [partintro] -- -You’re new to Kibana and want to give it a try. {kib} has sample data sets and -tutorials to help you get started. +You're new to {kib}, and not sure where to start. To quickly get started with {kib}, set up on Cloud and add a sample data set that you can use to get a handle on the full range of {kib} features. [float] -=== Sample data +[[cloud-set-up]] +== Set up on Cloud -You can use the <> to take {kib} for a test ride without having -to go through the process of loading data yourself. With one click, -you can install a sample data set and start interacting with -{kib} visualizations in seconds. You can access the sample data -from the {kib} home page. +To easily access {kib} in a single click, run our hosted Elasticsearch Service on Elastic Cloud. -[float] +. Log into the link:https://cloud.elastic.co/[Elasticsearch Service Console]. +If you need an account, register for a link:https://www.elastic.co/cloud/elasticsearch-service/signup[free 14-day trial]. + +. Click *Create deployment*, then give your deployment a name. -=== Add data tutorials -{kib} has built-in *Add Data* tutorials to help you set up -data flows in the Elastic Stack. These tutorials are available -from the Kibana home page. In *Add Data to Kibana*, find the data type -you’re interested in, and click its button to view a list of available tutorials. +. To use the default options, click *Create deployment*. If you want, you can modify the other deployment options, but the default options are great to get started. + +Be sure to copy down the password for the `elastic` user and Cloud ID information. You'll need that later. [float] -=== Hands-on experience +[[add-sample-data]] +== Get data into {kib} -The following tutorials walk you through searching, analyzing, -and visualizing data. +Before you create visualizations and analyze your data, you must get the data into {kib}. -* <>. You'll -learn to filter and query data, edit visualizations, and interact with dashboards. +The easiest way to get data into {kib} is to add a sample data set. {kib} has several sample data sets that you can use before loading your own data. -* <>. You'll manually load a data set and build -your own visualizations and dashboard. +These sample data sets showcase a variety of use cases: -[float] -=== Before you begin +* *Sample eCommerce orders* includes visualizations for tracking product-related information, +such as cost, revenue, and price. -Make sure you've <> and established -a <>. +* *Sample flight data* includes visualizations for monitoring flight routes. -If you are running our https://cloud.elastic.co[hosted Elasticsearch Service] -on Elastic Cloud, you can access Kibana with a single click. +* *Sample web logs* includes visualizations for monitoring website traffic. +To use the sample data sets: --- +. Go to the {kib} home page. + +. Click *Load a data set and a {kib} dashboard*. + +. Click *View data* and view the prepackaged dashboards, maps, and more. + +[role="screenshot"] +image::images/add-sample-data.png[] -include::{kib-repo-dir}/getting-started/add-sample-data.asciidoc[] +NOTE: The timestamps in the sample data sets are relative to when they are installed. +If you uninstall and reinstall a data set, the timestamps change to reflect the most recent installation. + +[float] +[[getting-started-next-steps]] +== Next steps + +* To get a hands-on experience using the sample flight data, follow the <> tutorial. + +* If you're ready to load an actual data set and build a dashboard, follow the <> tutorial. + +-- include::{kib-repo-dir}/getting-started/tutorial-sample-data.asciidoc[] @@ -62,4 +73,3 @@ include::{kib-repo-dir}/getting-started/tutorial-discovering.asciidoc[] include::{kib-repo-dir}/getting-started/tutorial-visualizing.asciidoc[] include::{kib-repo-dir}/getting-started/tutorial-dashboard.asciidoc[] - diff --git a/docs/user/index.asciidoc b/docs/user/index.asciidoc index 3911d57e05c9a4..ff100d07633686 100644 --- a/docs/user/index.asciidoc +++ b/docs/user/index.asciidoc @@ -1,13 +1,13 @@ include::introduction.asciidoc[] +include::getting-started.asciidoc[] + include::setup.asciidoc[] include::monitoring/configuring-monitoring.asciidoc[] include::security/securing-kibana.asciidoc[] -include::getting-started.asciidoc[] - include::discover.asciidoc[] include::visualize.asciidoc[] From 1f5229acdd34d0ed70a3b5b00eb786e32e7ce4d7 Mon Sep 17 00:00:00 2001 From: KOTungseth Date: Fri, 21 Feb 2020 16:33:03 -0600 Subject: [PATCH 2/4] Redirect for add-sample-data --- docs/redirects.asciidoc | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/redirects.asciidoc b/docs/redirects.asciidoc index 65de5c4f93d120..6d82dc69863124 100644 --- a/docs/redirects.asciidoc +++ b/docs/redirects.asciidoc @@ -43,7 +43,7 @@ This page was deleted. See <> and <>. [role="exclude",id="xpack-dashboard-only-mode"] == Dashboard-only mode -Using the `kibana_dashboard_only_user` role is deprecated. +Using the `kibana_dashboard_only_user` role is deprecated. Use <> instead. [role="exclude",id="pdf-layout-modes"] @@ -56,4 +56,7 @@ This page has moved. Please see <>. This page has moved. Please see <>. +[role="exclude",id="add-sample-data"] +== Add sample data +This page has moved. Please see <>. From 1eb5bd2efd3a77664a2eae0d8fdccfddf6fd3c77 Mon Sep 17 00:00:00 2001 From: KOTungseth Date: Mon, 24 Feb 2020 09:23:48 -0600 Subject: [PATCH 3/4] Link fix --- docs/redirects.asciidoc | 2 +- docs/user/getting-started.asciidoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/redirects.asciidoc b/docs/redirects.asciidoc index 6d82dc69863124..1b705092b70283 100644 --- a/docs/redirects.asciidoc +++ b/docs/redirects.asciidoc @@ -59,4 +59,4 @@ This page has moved. Please see <>. [role="exclude",id="add-sample-data"] == Add sample data -This page has moved. Please see <>. +This page has moved. Please see <>. diff --git a/docs/user/getting-started.asciidoc b/docs/user/getting-started.asciidoc index f69498ecca24b1..e59ee4521b986e 100644 --- a/docs/user/getting-started.asciidoc +++ b/docs/user/getting-started.asciidoc @@ -22,7 +22,7 @@ If you need an account, register for a link:https://www.elastic.co/cloud/elastic Be sure to copy down the password for the `elastic` user and Cloud ID information. You'll need that later. [float] -[[add-sample-data]] +[[get-data-in]] == Get data into {kib} Before you create visualizations and analyze your data, you must get the data into {kib}. From ba842cad5846a616f7ebc8d983a754a681eb00c6 Mon Sep 17 00:00:00 2001 From: KOTungseth Date: Fri, 28 Feb 2020 13:02:08 -0600 Subject: [PATCH 4/4] Review comments --- docs/user/getting-started.asciidoc | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/docs/user/getting-started.asciidoc b/docs/user/getting-started.asciidoc index e59ee4521b986e..d426ec111351cc 100644 --- a/docs/user/getting-started.asciidoc +++ b/docs/user/getting-started.asciidoc @@ -4,20 +4,20 @@ [partintro] -- -You're new to {kib}, and not sure where to start. To quickly get started with {kib}, set up on Cloud and add a sample data set that you can use to get a handle on the full range of {kib} features. +Ready to try out {kib} and see what it can do? To quickest way to get started with {kib} is to set up on Cloud, then add a sample data set that helps you get a handle on the full range of {kib} features. [float] [[cloud-set-up]] == Set up on Cloud -To easily access {kib} in a single click, run our hosted Elasticsearch Service on Elastic Cloud. +To access {kib} in a single click, run our hosted Elasticsearch Service on Elastic Cloud. . Log into the link:https://cloud.elastic.co/[Elasticsearch Service Console]. If you need an account, register for a link:https://www.elastic.co/cloud/elasticsearch-service/signup[free 14-day trial]. . Click *Create deployment*, then give your deployment a name. -. To use the default options, click *Create deployment*. If you want, you can modify the other deployment options, but the default options are great to get started. +. To use the default options, click *Create deployment*. You can modify the other deployment options, but the default options are great to get started. Be sure to copy down the password for the `elastic` user and Cloud ID information. You'll need that later. @@ -25,11 +25,9 @@ Be sure to copy down the password for the `elastic` user and Cloud ID informatio [[get-data-in]] == Get data into {kib} -Before you create visualizations and analyze your data, you must get the data into {kib}. +The easiest way to get data into {kib} is to add a sample data set. -The easiest way to get data into {kib} is to add a sample data set. {kib} has several sample data sets that you can use before loading your own data. - -These sample data sets showcase a variety of use cases: +{kib} has several sample data sets that you can use before loading your own data: * *Sample eCommerce orders* includes visualizations for tracking product-related information, such as cost, revenue, and price. @@ -56,7 +54,7 @@ If you uninstall and reinstall a data set, the timestamps change to reflect the [[getting-started-next-steps]] == Next steps -* To get a hands-on experience using the sample flight data, follow the <> tutorial. +* To get a hands-on experience creating visualizations, follow the <> tutorial. * If you're ready to load an actual data set and build a dashboard, follow the <> tutorial.