[DOCS] Adds quick start by KOTungseth · Pull Request #78822 · elastic/kibana

KOTungseth · 2020-09-29T16:55:39Z

Preview: Quick start

Summary

Removes the getting started content from the docs
Adds a quick start using the sample eCommerce data
Removes old images

Checklist

Documentation was added for features that require explanation or tutorials

elasticmachine · 2020-09-29T16:55:41Z

Pinging @elastic/kibana-docs (Team:Docs)

alexfrancoeur · 2020-10-01T13:56:56Z

This is probably fundamentally a large change and likely a separate discussion, but as we rethink how we want to onboard folks to Elastic, adding data is becoming more critical. While I understand the simplicity of quickly adding sample data to onboard to Kibana, I wonder if we need to be thinking more holistically. We're slowly starting to make this transition in product with this PR #78881.

With ingest manager and integrations, its pretty easy to start ingesting system data in most cases. @VijayDoshi @snide maybe it's not for this quick start, but should we start leaning into this more? @KOTungseth are there other quick starts already in the works that take ingestion into account and are leading with agent?

KOTungseth · 2020-10-01T21:14:45Z

@alexfrancoeur our thought process was that we wanted users to get a handle on Kibana features without adding/ingesting their own data. Since this is a quick start, we thought the quickest way to get users up and running is to use sample data.

We are currently writing a tutorial/short guide that includes the steps to ingest data (@gchaps) . More to come soon!

docs/getting-started/quick-start-guide.asciidoc

gchaps · 2020-10-02T14:39:44Z

docs/getting-started/quick-start-guide.asciidoc

+[[set-up-on-cloud]]
+== Set up on cloud
+
+include::{docs-root}/shared/cloud/ess-getting-started.asciidoc[]


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

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.

docs/getting-started/quick-start-guide.asciidoc

gchaps · 2020-10-02T14:48:14Z

docs/getting-started/quick-start-guide.asciidoc

+[[query-the-data]]
+== Explore the data
+
+With *Discover*, use {ref}/query-dsl-query-string-query.html#query-string-syntax[Elasticsearch


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

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.

docs/getting-started/quick-start-guide.asciidoc

gchaps · 2020-10-02T14:56:03Z

docs/getting-started/quick-start-guide.asciidoc

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


Too much bold in this step.

Does the visualization automatically appear on the dashboard?

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

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

Face palm

gchaps · 2020-10-02T14:59:31Z

docs/getting-started/quick-start-guide.asciidoc

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


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

docs/getting-started/quick-start-guide.asciidoc

gchaps · 2020-10-02T15:15:43Z

docs/getting-started/quick-start-guide.asciidoc

+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 


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

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.

* [DOCS] Getting started refresh * Dashboard changes * Discover and Dashboard changes * [DOCS] Adds quick start * Redirects * Redirects pt 2 * Redirects pt * More redirect issues * Removed second chunk of KQL tasks * Review comments # Conflicts: # docs/getting-started/tutorial-define-index.asciidoc # docs/getting-started/tutorial-full-experience.asciidoc # docs/images/tutorial-dashboard.png # docs/images/tutorial-full-inspect1.png # docs/images/tutorial-pattern-1.png # docs/images/tutorial-visualize-bar-1.5.png # docs/images/tutorial-visualize-map-2.png # docs/images/tutorial-visualize-md-2.png # docs/images/tutorial-visualize-pie-2.png # docs/images/tutorial-visualize-pie-3.png # docs/images/tutorial-visualize-wizard-step-1.png

* master: (23 commits) Table visualization renderer (elastic#79455) Migrate Jest JUnit reporter to TS (elastic#79919) store sorted bundleRefExportIds (elastic#80011) update chromedriver dependency to 86.0.0 (elastic#79972) [Security Solution][Case] Fix bug when changing connectors (elastic#80002) [kbn/std] add observable helpers to aid with rxjs 7 upgrade (elastic#79752) [Security Solution][Resolver] Pill numbers in compact notation (elastic#80038) [Logs UI] Sync logs timerange with wider Kibana (elastic#79444) [DOCS] Adds quick start (elastic#78822) [Ingest Manager]Fix ingest manager UI renaming (elastic#80036) [Monitoring] Fixed internal monitoring check (elastic#79241) [Security Solution][Exception Modal] Removes list operators in exception modal for EQL rules (elastic#79871) Update development documentation about REST API best practices (elastic#80009) [Monitoring] Improve indices loading against larger metricbeat-* indices (elastic#79190) [CI] Move kibana build dir outside of repo for functional tests (elastic#80018) [kbn/optimizer] bump low or add missing limits when updating automatically (elastic#80013) [Enterprise Search] Added a Credentials page to App Search (elastic#79749) [DOCS] Canvas refresh for 7.10 (elastic#80017) [TSVB] Add ignore global filters to series options (elastic#79337) Remove this check (elastic#79202) ...

* [DOCS] Getting started refresh * Dashboard changes * Discover and Dashboard changes * [DOCS] Adds quick start * Redirects * Redirects pt 2 * Redirects pt * More redirect issues * Removed second chunk of KQL tasks * Review comments # Conflicts: # docs/getting-started/tutorial-define-index.asciidoc # docs/getting-started/tutorial-full-experience.asciidoc # docs/images/tutorial-dashboard.png # docs/images/tutorial-full-inspect1.png # docs/images/tutorial-pattern-1.png # docs/images/tutorial-visualize-bar-1.5.png # docs/images/tutorial-visualize-map-2.png # docs/images/tutorial-visualize-md-2.png # docs/images/tutorial-visualize-pie-2.png # docs/images/tutorial-visualize-pie-3.png # docs/images/tutorial-visualize-wizard-step-1.png

KOTungseth added 4 commits September 16, 2020 12:46

[DOCS] Getting started refresh

996b4f3

Dashboard changes

5726d32

Discover and Dashboard changes

d0265d4

[DOCS] Adds quick start

31b1b81

KOTungseth added Team:Docs v8.0.0 release_note:skip Skip the PR/issue when compiling release notes v7.10.0 labels Sep 29, 2020

KOTungseth self-assigned this Sep 29, 2020

KOTungseth added 6 commits September 29, 2020 12:11

Merge branch 'master' into docs/gs-refresh

1783172

Redirects

076f51a

Redirects pt 2

5ccaea5

Redirects pt

1345f21

More redirect issues

b9a9a05

Removed second chunk of KQL tasks

8c70189

KOTungseth requested review from dsmith001, gchaps and rayafratkina September 30, 2020 20:39

gchaps reviewed Oct 2, 2020

View reviewed changes

Review comments

20ab783

KOTungseth merged commit a8b5e9f into elastic:master Oct 8, 2020

KOTungseth deleted the docs/gs-refresh branch October 8, 2020 20:16

KOTungseth mentioned this pull request Oct 8, 2020

[7.x] [DOCS] Adds quick start (#78822) #80074

Merged

KOTungseth mentioned this pull request Oct 8, 2020

[7.10] [DOCS] Adds quick start (#78822) #80075

Merged

Conversation

KOTungseth commented Sep 29, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Uh oh!

elasticmachine commented Sep 29, 2020

Uh oh!

alexfrancoeur commented Oct 1, 2020

Uh oh!

KOTungseth commented Oct 1, 2020

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

KOTungseth commented Sep 29, 2020 •

edited

Loading