-
Notifications
You must be signed in to change notification settings - Fork 8.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DOCS] Adds quick start #78822
[DOCS] Adds quick start #78822
Conversation
Pinging @elastic/kibana-docs (Team:Docs) |
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? |
@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! |
[[set-up-on-cloud]] | ||
== Set up on cloud | ||
|
||
include::{docs-root}/shared/cloud/ess-getting-started.asciidoc[] |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
[[query-the-data]] | ||
== Explore the data | ||
|
||
With *Discover*, use {ref}/query-dsl-query-string-query.html#query-string-syntax[Elasticsearch |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
[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*. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Face palm
[[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}>>. |
There was a problem hiding this comment.
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.
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 |
There was a problem hiding this comment.
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....
There was a problem hiding this comment.
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.
* [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
* [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
* [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
Preview: Quick start
Summary
Checklist