Skip to content
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] Updates intro doc #58161

Merged
merged 8 commits into from
Mar 5, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
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 added docs/images/intro-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 added docs/images/intro-data-tutorial.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 added docs/images/intro-discover.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 added docs/images/intro-kibana.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 added docs/images/intro-management.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 added docs/images/intro-spaces.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
164 changes: 156 additions & 8 deletions docs/user/introduction.asciidoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,160 @@
[[introduction]]
== Introduction
== {kib} — your window into the Elastic Stack
++++
<titleabbrev>What is Kibana?</titleabbrev>
++++

Kibana is an open source analytics and visualization platform designed to work with Elasticsearch. You use Kibana to
search, view, and interact with data stored in Elasticsearch indices. You can easily perform advanced data analysis
and visualize your data in a variety of charts, tables, and maps.
**_Explore and visualize your data and manage all things Elastic Stack._**

Kibana makes it easy to understand large volumes of data. Its simple, browser-based interface enables you to quickly
create and share dynamic dashboards that display changes to Elasticsearch queries in real time.
Whether you’re a user or admin, {kib} makes your data actionable by providing
three key functions:

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.**
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Use {kib} to explore your {es} data, and then build beautiful visualizations and dashboards.

* **{kib} is a UI for managing {es} clusters.**
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
Copy link
Contributor

Choose a reason for hiding this comment

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

Is the &mdash; on purpose?

document discovery to SIEM, {kib} is the portal for accessing these and other capabilities.

[role="screenshot"]
image::images/intro-kibana.png[]

[float]
[[where-to-start-kibana]]
=== Where do I start?
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

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 moved this section to the end.


There is no faster way to try out {kib} than with our hosted {es} Service.
https://www.elastic.co/cloud/elasticsearch-service/signup[Sign up for a free trial]
and start exploring data in minutes.

You can also install {kib} on your own &mdash; no code, no additional
infrastructure required. If you don’t have {es}, you’ll need that too.
Think of Elasticsearch as the engine that stores and processes the data, with {kib} sitting on top.

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

Choose a reason for hiding this comment

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

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


Our <<add-sample-data, sample data sets>> enable you to take {kib} for a test ride without having
to go through the process of loading data yourself. Or, try our <<getting-started, built-in tutorials>>,
which can help you quickly set up data flows between your app and the Elastic Stack.

[role="screenshot"]
image::images/intro-data-tutorial.png[]

With both scenarios, you get data, index patterns, visualizations, and dashboards.
<<index-patterns, Index patterns>> are key to Kibana &mdash; they identify which
{es} indices contain the data that you want to work with.

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.

[float]
[[explore-and-query]]
=== Explore & query
Copy link
Contributor

Choose a reason for hiding this comment

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

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?


Ready to dive into your data? With <<discover, Discover>>, you can explore your data and
search for hidden insights and relationships. Ask your questions, and then
narrow the results to just the data you want.

[role="screenshot"]
image::images/intro-discover.png[]

[float]
[[visualize-and-analyze]]
=== Visualize & analyze

A visualization is worth a thousand log lines, and {kib} provides
many options for showcasing your data. Use <<visualize, Visualize>> to create
classic line charts, bar graphs, pie charts, histograms, and tables
(just to name a few).

Once your visualizations are just the way you want,
use <<dashboard, Dashboard>> to collect them in one place. A dashboard provides
insights into your data from multiple perspectives, and you can watch the data
change in real time.

[role="screenshot"]
image::images/intro-dashboard.png[]

[float]
[[more-ways-to-visualize]]
=== Even more ways to visualize
Copy link
Contributor

Choose a reason for hiding this comment

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

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.


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

* <<lens, Lens>> provides a drag-and-drop experience that helps
you get insights from your data in just a few clicks. If there is a
better visualization for your data, Lens suggests it, allowing
for quick switching between visualization types.

* <<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..
Copy link
Contributor

Choose a reason for hiding this comment

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

Double period


* <<maps, Elastic Maps>> enables you to ask (and answer) meaningful
questions of your location-based data. Elastic Maps supports multiple
layers and data sources, mapping of individual geo points and shapes,
and dynamic client-side styling.

* <<TSVB, TSVB>> allows you to combine

Choose a reason for hiding this comment

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

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

Copy link
Contributor

Choose a reason for hiding this comment

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

Choose a reason for hiding this comment

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

Ah interesting, naming is hard 😄

an infinite number of aggregations to display complex data in a meaningful way.
With TSVB, you can analyze multiple index patterns and customize
every aspect of your visualization. Choose your own date format and color
gradients, and easily switch your data view between time series, metric,
top N, gauge, and markdown.

[float]
[[organize-and-secure]]
=== Organize & secure

Want to share Kibana’s goodness with other people or teams? You can do so with
<<xpack-spaces, Spaces>>, built for organizing your visualizations, dashboards, and indices.
Think of a space as its own mini {kib} installation &mdash; it’s isolated from
all other spaces, so you can tailor it to your specific needs without impacting others.

You can even choose which features to enable within each space. Don’t need
Machine learning in your “Executive” space? Simply turn it off.

[role="screenshot"]
image::images/intro-spaces.jpg[]

You can take this all one step further with Kibana’s security features, and
control which users have access to each space. {kib} allows for fine-grained
controls here, so you can give a user read-only access to
dashboards in one space, but full access to all of Kibana’s features in another.

[float]
[[manage-all-things-stack]]
=== Manage all things Elastic Stack

<<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?
Copy link
Contributor

Choose a reason for hiding this comment

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

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

Turn on dark mode? Kibana has UIs for all that.

[role="screenshot"]
image::images/intro-management.png[]

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

Choose a reason for hiding this comment

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

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

can help you find security vulnerabilities,
monitor performance, and address your business needs. Get alerted if a key
metric spikes. Detect anomalous behavior or forecast future spikes. Root out
bottlenecks in your application code. Kibana doesn’t limit or dictate how you explore your data.

[float]
[[try-kibana]]
=== Give Kibana a try

Grab an installation of {kib} and start working with your data.
Our <<tutorial-build-dashboard, Getting Started>> and in-product guidance can
help you get up and running, faster. Use the Help menu for any questions or
feedback you might have.