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 add data content #81093

Merged
merged 13 commits into from
Oct 30, 2020
Merged

[DOCS] Updates add data content #81093

merged 13 commits into from
Oct 30, 2020

Conversation

gchaps
Copy link
Contributor

@gchaps gchaps commented Oct 20, 2020

This PR updates the "Add Data" content to include content for Fleet.

Preview: https://kibana_81093.docs-preview.app.elstc.co/guide/en/kibana/master/connect-to-elasticsearch.html

@gchaps gchaps added Team:Docs v8.0.0 release_note:skip Skip the PR/issue when compiling release notes v7.10.0 v7.11.0 labels Oct 20, 2020
@gchaps
Copy link
Contributor Author

gchaps commented Oct 20, 2020

@dedemorton Can I please get your input on the "Add data" and "Add Elastic Agent" sections?


* Upload a CSV, JSON, or log file with the File Data Visualizer.
* Add data from popular apps and services
* Add data using an Elastic Agent
Copy link
Contributor

Choose a reason for hiding this comment

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

Not exactly clear how line 7 is different from line 8 (Elastic Agent is the new way of adding data from popular apps and services, no?)

Copy link
Contributor

Choose a reason for hiding this comment

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

I'd also indicate here that this is beta

[role="screenshot"]
image::images/add-data-tutorials.png[Add Data tutorials]


Copy link
Contributor

Choose a reason for hiding this comment

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

Might be worth stating explicitly somewhere that Elastic Agent is an alternative to installing and managing Beats individually. I think there will be some confusion for users because Elastic Agent installs and manages Beats under the hood. We really want that to be an implementation detail that most users don't need to know about, though.


beta[]

Fleet is a single, unified way to collect logs and metrics from systems
Copy link
Contributor

Choose a reason for hiding this comment

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

This description blurs the lines between Fleet and agent. Agent is how you collect logs/metrics. Fleet is the UI you use to add and manage agents. You might want to look at the Fleet overview (thought honestly I want to rework that because it's a bit disjointed). https://www.elastic.co/guide/en/ingest-management/7.10/fleet-overview.html

beta[]

Fleet is a single, unified way to collect logs and metrics from systems
and services across your organization. You don't have to install multiple
Copy link
Contributor

Choose a reason for hiding this comment

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

"You don't have to" makes it sound like this is optional.

Maybe: "Instead of installing multiple agents on each host you want to monitor, you install a single agent that manages data collection, making it easier to deploy policies across your infrastructure."

(Kind of wordy and I'm not sure users will understand what a policy is at this point, but hopefully you see my point.)

@dedemorton
Copy link
Contributor

@gchaps One thing we need to be aware of: I don't think we are recommending that users try this in a production environment. Check with @ph to be sure.

@ph
Copy link
Contributor

ph commented Oct 21, 2020

Correct we recommend a testing/dev environment.

@gchaps gchaps marked this pull request as ready for review October 22, 2020 21:28
@elasticmachine
Copy link
Contributor

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


To start working with your data in {kib}, you can:
The fastest way to add data to {kib} is to use one of the built-in options.
Copy link
Contributor

Choose a reason for hiding this comment

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

One comment about "add data to Kibana". This statement is a little technically misleading. Kibana does not store data so you never add data to kibana. You add data to Elasticsearch or the Elastic stack. Sometimes you add data by using kibana like with sample data or file upload.

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree.

<<kibana-ml-settings, Advanced Settings>>.

[role="screenshot"]
image::images/add-data-fv.png[File Data Visualizer]

The File Data Visualizer uses the {ref}/ml-find-file-structure.html[find_file_structure API] to analyze
the uploaded file and to suggest ingest pipelines and mappings for your data.
For geospatial data, you can use the File Data Visualizer or the
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 you need to call out File Data Visualizer or GeoJSon Uploader. How about just changing to "See <<import-geospatial-data, Import geospatial data>> for uploading files with geospatial data."

Choose a reason for hiding this comment

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

++

Copy link

@alexfrancoeur alexfrancoeur left a comment

Choose a reason for hiding this comment

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

Dropped in a few comments, let me know what you think @gchaps !

@@ -1,108 +1,75 @@
[[connect-to-elasticsearch]]
== Add data to {kib}

Choose a reason for hiding this comment

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

Similar to the comment from Nathan, should we simply have "Add data" here to avoid confusion?

If you're not ready to use your own data, you can add a <<get-started, sample data set>>
to see all that you can do in {kib}.
[discrete]
=== Add Elastic Agent

Choose a reason for hiding this comment

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

I think the split between add data and add Elastic agent is fine now, because we have them in product. We'll have to work with @mostlyjason on when we can begin to default to agent and remove add data from the docs (similarly to how we did with Lens) and eventually, product

Choose a reason for hiding this comment

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

These two things are very similar, integrations with Agent + Fleet are the next generation of modules. I wonder if we can spin this in a way with "get a sneak peak of where we're going with.." or something along those lines.

[[upload-data-kibana]]
=== Upload a CSV, JSON, or log file
beta[] *Elastic Agent* is a centralized way to set up your data integrations.
With the *Fleet* UI, you can add

Choose a reason for hiding this comment

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

Should we just say with "Fleet" instead of "Fleet UI"?


To start working with your data in {kib}, you can:
The fastest way to add data to {kib} is to use one of the built-in options.

Choose a reason for hiding this comment

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

Thoughts on replacing "use one of our built in options" with "one of our many ingest options"?

Beats data shipper to periodically collect and send data to {es}.
You can then use the pre-built dashboards to explore and analyze the data.
[discrete]
=== Custom options for loading your data

Choose a reason for hiding this comment

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

Thoughts on using "Additional options for loading your data"? or "Options for loading your custom data"

You access the tutorials from the home page.
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.
If the built-in options don't work for you, you can index your

Choose a reason for hiding this comment

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

Similar to my comment above, thoughts on replacing "If the built-in options don't work for you" with "If one of our multiple ingest options don't work for you"?

+
When searching in *Discover* and creating visualizations, you choose a pattern
from the index pattern menu to specify the {es} indices that contain the data you want to explore.
* To add data for Elastic Observability, see {observability-guide}/add-observability-data.html[Send data to Elasticsearch].

Choose a reason for hiding this comment

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

Probably another discussion, but a common naming convention and framework for ingestion "How to's" might make it easier to consume for our end users.

<<kibana-ml-settings, Advanced Settings>>.

[role="screenshot"]
image::images/add-data-fv.png[File Data Visualizer]

The File Data Visualizer uses the {ref}/ml-find-file-structure.html[find_file_structure API] to analyze
the uploaded file and to suggest ingest pipelines and mappings for your data.
For geospatial data, you can use the File Data Visualizer or the

Choose a reason for hiding this comment

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

++

Copy link
Contributor

@dedemorton dedemorton left a comment

Choose a reason for hiding this comment

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

It's looking good...just one minor correction to your note.


*Data Visualizer*.
NOTE: This feature is not intended for use as part of a
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure I like this note because it's a little misleading. Eventually it will be the main way to ingest data, but right now, it's not recommended in a production environment. Maybe qualify it by saying, "The beta release of this feature...."


To start working with your data in {kib}, you can:
The fastest way to add data to {kib} is to use one of the built-in options.
Copy link
Contributor

Choose a reason for hiding this comment

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

I agree.

Copy link
Contributor

@nreese nreese left a comment

Choose a reason for hiding this comment

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

LGTM

@gchaps gchaps requested a review from KOTungseth October 29, 2020 15:40
@@ -1,108 +1,73 @@
[[connect-to-elasticsearch]]
== Add data to {kib}
== Add data
Copy link
Contributor

Choose a reason for hiding this comment

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

It is confusing that this line and line 18 are both Add data.

docs/setup/connect-to-elasticsearch.asciidoc Outdated Show resolved Hide resolved
docs/setup/connect-to-elasticsearch.asciidoc Outdated Show resolved Hide resolved
docs/setup/connect-to-elasticsearch.asciidoc Outdated Show resolved Hide resolved
docs/setup/connect-to-elasticsearch.asciidoc Outdated Show resolved Hide resolved
docs/setup/connect-to-elasticsearch.asciidoc Outdated Show resolved Hide resolved
@gchaps gchaps merged commit 3fbaf22 into elastic:master Oct 30, 2020
@gchaps gchaps deleted the docs/add-fleet branch October 30, 2020 17:29
gchaps added a commit to gchaps/kibana that referenced this pull request Oct 30, 2020
* [DOCS] Updates add data content

* [DOCS] Incorporated review comments

* [DOCS] Adds content for geojson upload

* [DOCS] Fixes link

* [DOCS] Incorporates review comments

* [DOCS] Minor edits

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

Co-authored-by: Kaarina Tungseth <[email protected]>
# Conflicts:
#	docs/setup/connect-to-elasticsearch.asciidoc
gchaps added a commit that referenced this pull request Oct 30, 2020
* [DOCS] Updates add data content

* [DOCS] Incorporated review comments

* [DOCS] Adds content for geojson upload

* [DOCS] Fixes link

* [DOCS] Incorporates review comments

* [DOCS] Minor edits

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/setup/connect-to-elasticsearch.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

Co-authored-by: Kaarina Tungseth <[email protected]>
# Conflicts:
#	docs/setup/connect-to-elasticsearch.asciidoc
gmmorris added a commit to gmmorris/kibana that referenced this pull request Nov 2, 2020
* master:
  Add derivative function (elastic#81178)
  [Discover] Deangularize context_app.html, part 3 (elastic#81838)
  [Visualize] Vis listing page breaks on unknown vis type (elastic#82018)
  Rename `batchSize` parameter to `batch_size` to be consisten with the API namings guidelines. (elastic#82123)
  Minor edits in Single Metric Viewer (elastic#82159)
  [Actions] Fix type contract (elastic#82168)
  Upgrade EUI to v30.1.1 (elastic#81499)
  Skip failing ES snapshot test (elastic#82207)
  Skip ES snapshot failing suite (elastic#82206)
  [Alerting UI] Grouped list of alert types using producers in Types filter of Alerts tab (elastic#81876)
  [Maps] convert vector style component to typescript round 1 (elastic#81961)
  Fix link to upgrade assistant (elastic#82138)
  Rename "service overview" to "service inventory" (elastic#81933)
  adjust policy test to drop test for server addresses (elastic#82120)
  Cleanup/codeowners (elastic#82146)
  [DOCS] Updates add data content (elastic#81093)
  [DOCS] Remove index mgmt docs (elastic#82099)
  [Search] fix cancelation related memory leaks (elastic#81996)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:skip Skip the PR/issue when compiling release notes Team:Docs v7.10.0 v7.11.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants