[DOCS] Updates intro doc #58161

gchaps · 2020-02-20T19:28:11Z

Summary

This PR updates the introduction to Kibana doc to better tell the Kibana story.

[skip ci]

Preview:
http://kibana_58161.docs-preview.app.elstc.co/guide/en/kibana/master/introduction.html

elasticmachine · 2020-02-20T19:28:13Z

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

gchaps · 2020-02-20T19:37:07Z

cla/check

KOTungseth · 2020-02-21T14:46:49Z

docs/user/introduction.asciidoc


-Setting up Kibana is a snap. You can install Kibana and start exploring your Elasticsearch indices in minutes -- no
-code, no additional infrastructure required.
+* **{kib} is an open-source analytics and visualization platform.**


For all three of these bullets, I would remove {kib} is. So it would look like:

An open-source analytics and visualization platform.

A UI for managing Elasticsearch clusters.

A centralized hub for our solutions.

KOTungseth · 2020-02-21T14:48:45Z

docs/user/introduction.asciidoc

+Manage your security settings, assign user roles, monitor the Stack,
+ingest and roll up your data...the list goes on.
+
+* **{kib} is a centralized hub for our solutions.** &mdash; From log analytics to


Is the — on purpose?

KOTungseth · 2020-02-21T15:00:43Z

docs/user/introduction.asciidoc

+
+[float]
+[[get-data-into-kibana]]
+=== Try {kib} with our data sets and tutorials


This section doesn't encompass all of the ways users can get data into Kibana. Since this is the intro, what if a user is interested in going through the process of loading the data themselves? I think this content is a better fit in our new Get data into Kibana section.

Here, I would say something like:
`Before you can build beautiful visualizations and dashboards, you must first get your data into Kibana. Kibana supports several ways to get your data in, such as file upload, etc.

If you're not ready to use your own data, our <<add-sample-data, sample data sets>> enable you to take {kib} for a test ride ...

KOTungseth · 2020-02-21T15:06:19Z

docs/user/introduction.asciidoc

+
+* <<canvas, Canvas>> gives you the ability to present your data in a
+visually compelling, pixel-perfect report. Give your data the “wow” factor
+needed to impress your CEO or to captivate people with a big-screen display..


Double period

KOTungseth · 2020-02-21T15:07:46Z

docs/user/introduction.asciidoc

+
+[float]
+[[more-ways-to-visualize]]
+=== Even more ways to visualize


I would remove this title. Line 88 does a good job of introducing this content, and these apps do more than visualize the data, they help with analysis too.

KOTungseth · 2020-02-21T15:26:45Z

docs/user/introduction.asciidoc

+
+<<management, Management>> provides guided processes for managing all
+things Elastic Stack &mdash; indices, clusters, licenses, UI settings, index patterns,
+spaces, and more. Want to update your {es} indices? Set user roles and privileges?


Since you already talk about spaces in Organize & secure, I would leave it out here.

KOTungseth · 2020-02-21T15:28:26Z

docs/user/introduction.asciidoc

+
+[float]
+[[explore-and-query]]
+=== Explore & query


I like the consistency of Explore & query, Visualize & analyze, and Organize & secure, but the other section titles use and. Maybe make this consistent across all of these titles?

KOTungseth · 2020-02-21T15:30:26Z

docs/user/introduction.asciidoc

+[[extend-your-use-case]]
+=== Extend your use case...or add a new one
+
+As a hub for our https://www.elastic.co/products/[solutions], {kib}


I would remove our. It makes it sound like these are Kibana's solutions when they are really Elastic's solutions.

KOTungseth · 2020-02-21T16:52:43Z

docs/user/introduction.asciidoc

+
+[float]
+[[where-to-start-kibana]]
+=== Where do I start?


I don't think this section belongs in the introduction. I think users want to know what they are getting into before they learn about jumping in and setting up. This section is a better fit for the getting started section.

i moved this section to the end.

alexfrancoeur · 2020-03-02T14:18:20Z

docs/user/introduction.asciidoc

+(If a tutorial doesn’t exist for your data, go to the
+{beats-ref}/beats-reference.html[Beats overview] to learn about other data shippers
+in the {beats} family.)
+* Import log data using the file upload feature.


@gchaps I don't know if we need to specify "log data" here. Maybe instead, we say "static" data? Simply because it's a one time thing. Also, are there docs we can link to for file upload?

alexfrancoeur · 2020-03-02T14:19:59Z

docs/user/introduction.asciidoc

+From the home page, {kib} provides these options for getting data in:
+
+* <<add-sample-data, Add a sample data set>> and take {kib} for a test drive without loading data yourself.
+* Set up a data flow between your app and the Elastic Stack using our built-in tutorials.


A lot of these modules aren't necessarily app specific. For instance, metrics / logs on your infrastructure or security events. Maybe instead we make this sentence a bit more generic and simply say "Easily set up known data sources.." or "Set up a data flow to Elasticsearch.."

alexfrancoeur · 2020-03-02T14:22:03Z

docs/user/introduction.asciidoc

+{beats-ref}/beats-reference.html[Beats overview] to learn about other data shippers
+in the {beats} family.)
+* Import log data using the file upload feature.
+* {ref}/getting-started-index.html[Index your data] in Elasticsearch.


I know it's getting started, but some additional context might help here. If you're not using beats, then you're likely using our REST API or client libraries. "Index your data into Elasticsearch with REST API's or client libraries". That doesn't flow well, but gives a bit more context.

alexfrancoeur · 2020-03-02T14:25:08Z

docs/user/introduction.asciidoc

+layers and data sources, mapping of individual geo points and shapes,
+and dynamic client-side styling.
+
+* <<TSVB, TSVB>> allows you to combine


I know "Time Series Visual Builder" is a mouthful, but are we really externally marketing this as TSVB now? I had thought it was just internal

@alexfrancoeur there was an effort last year to change all instances of Time Series Visual Builder to TSVB.

Ah interesting, naming is hard 😄

alexfrancoeur · 2020-03-02T14:26:28Z

LGTM @gchaps . I dropped a few comments in, mostly in the getting data into Kibana section. @VijayDoshi @AlonaNadler might want to give it a quick peek too

docs/user/introduction.asciidoc

dsmith001 · 2020-03-04T22:30:33Z

docs/user/introduction.asciidoc

+
+{kib} also offers these features that address specific visualization needs.
+
+* <<visualize, Visualize>> allows you to display your data in


Right now we make mention of Lens in the intro of Visualize & Analyze, but we don't mention it again any where else in the rest of the larger intro. I know it breaks up the 2 sentence pattern of the bullets, but maybe for the visualize bullet we add a middle sentence that just says "It's also home to Lens, a drag-and-drop interface for rapid ad-hoc chart building." If we use that verbiage we'll need to start the third sentence differently by taking out the "also."

* [DOCS] Updates intro doc * [DOCS] Incorporates review comments * [DOCS] Added image of a solution and other tweaks * [DOCS] Updates image and content in get data section * [DOCS] Incorporates review comments into docs intro * Updated Lens and Visualize * [DOCS] Adds note about Lens * [DOCS] Added link to es docs Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* [DOCS] Updates intro doc * [DOCS] Incorporates review comments * [DOCS] Added image of a solution and other tweaks * [DOCS] Updates image and content in get data section * [DOCS] Incorporates review comments into docs intro * Updated Lens and Visualize * [DOCS] Adds note about Lens * [DOCS] Added link to es docs Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

kibanamachine · 2020-03-06T16:58:45Z

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

* [DOCS] Updates intro doc (#58161) * [DOCS] Updates intro doc * [DOCS] Incorporates review comments * [DOCS] Added image of a solution and other tweaks * [DOCS] Updates image and content in get data section * [DOCS] Incorporates review comments into docs intro * Updated Lens and Visualize * [DOCS] Adds note about Lens * [DOCS] Added link to es docs Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> * [DOCS] Fixes broken images Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

* [DOCS] Updates intro doc * [DOCS] Incorporates review comments * [DOCS] Added image of a solution and other tweaks * [DOCS] Updates image and content in get data section * [DOCS] Incorporates review comments into docs intro * Updated Lens and Visualize * [DOCS] Adds note about Lens * [DOCS] Added link to es docs Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>

[DOCS] Updates intro doc

2da06a7

gchaps added Team:Docs v8.0.0 release_note:skip Skip the PR/issue when compiling release notes v7.5.0 v7.7.0 v7.6.0 labels Feb 20, 2020

gchaps requested a review from KOTungseth February 20, 2020 19:28

KOTungseth reviewed Feb 21, 2020

View reviewed changes

[DOCS] Incorporates review comments

679d602

KOTungseth approved these changes Feb 25, 2020

View reviewed changes

gchaps added 2 commits February 26, 2020 09:27

[DOCS] Added image of a solution and other tweaks

f3e4c00

[DOCS] Updates image and content in get data section

a5e72ea

alexfrancoeur reviewed Mar 2, 2020

View reviewed changes

[DOCS] Incorporates review comments into docs intro

6aaa854

gchaps requested review from AlonaNadler and VijayDoshi March 2, 2020 16:42

VijayDoshi reviewed Mar 3, 2020

View reviewed changes

docs/user/introduction.asciidoc Outdated Show resolved Hide resolved

VijayDoshi requested a review from dsmith001 March 3, 2020 19:09

Updated Lens and Visualize

84c2500

dsmith001 reviewed Mar 4, 2020

View reviewed changes

gchaps added 2 commits March 4, 2020 16:03

[DOCS] Adds note about Lens

8a13c2a

[DOCS] Added link to es docs

c8c195a

gchaps merged commit 8ded7f9 into elastic:master Mar 5, 2020

gchaps deleted the docs/update-intro branch March 5, 2020 16:56

gchaps mentioned this pull request Mar 5, 2020

[7.x] [DOCS] Updates intro doc (#58161) #59457

Merged

gchaps mentioned this pull request Mar 5, 2020

[7.6] [DOCS] Updates intro doc (#58161) #59458

Merged

gchaps mentioned this pull request Mar 5, 2020

[7.5] [DOCS] Updates intro doc (#58161) #59459

Merged

kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Mar 6, 2020

kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Mar 6, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DOCS] Updates intro doc #58161

[DOCS] Updates intro doc #58161

gchaps commented Feb 20, 2020 •

edited

Loading

elasticmachine commented Feb 20, 2020

gchaps commented Feb 20, 2020

KOTungseth Feb 21, 2020

KOTungseth Feb 21, 2020

KOTungseth Feb 21, 2020

KOTungseth Feb 21, 2020

KOTungseth Feb 21, 2020

KOTungseth Feb 21, 2020

KOTungseth Feb 21, 2020

KOTungseth Feb 21, 2020

KOTungseth Feb 21, 2020

gchaps Feb 25, 2020

alexfrancoeur Mar 2, 2020

alexfrancoeur Mar 2, 2020

alexfrancoeur Mar 2, 2020

alexfrancoeur Mar 2, 2020

KOTungseth Mar 3, 2020

alexfrancoeur Mar 3, 2020

alexfrancoeur commented Mar 2, 2020

dsmith001 Mar 4, 2020

kibanamachine commented Mar 6, 2020


		{kib} also offers these features that address specific visualization needs.

		* <<visualize, Visualize>> allows you to display your data in

[DOCS] Updates intro doc #58161

[DOCS] Updates intro doc #58161

Conversation

gchaps commented Feb 20, 2020 • edited Loading

Summary

elasticmachine commented Feb 20, 2020

gchaps commented Feb 20, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexfrancoeur commented Mar 2, 2020

Choose a reason for hiding this comment

kibanamachine commented Mar 6, 2020

gchaps commented Feb 20, 2020 •

edited

Loading