elastic / kibana

Your window into the Elastic Stack
https://www.elastic.co/products/kibana
Other
19.62k stars 8.22k forks source link

Create title and description based on guidelines for EMS, Sample Data and File Upload #114336

Closed alexfrancoeur closed 3 years ago

alexfrancoeur commented 3 years ago

In 7.16, we are planning to introduce the unified integrations view. The primary goal of this view is to improve the discoverability for all data ingest options at Elastic. As part of this initiative, we'd like to improve the titles and descriptions of each integration card and do so in a uniform way.

Guidelines

These are the general guidelines we plan to use for the integration cards

image

Examples

Here's an example for how we can leverage these guidelines, but please follow the guidelines as you see fit.

Current Title Current Description New Title New Description
EMS Boundaries Administrative boundaries from Elastic Maps Service. Elastic Maps Service Download adminstrative boundaries from the Elastic Maps Service.
Sample web logs Sample data, visualizations, and dashboards for monitoring web logs. Sample Web Logs Add sample data and assets to Elasticsearch and Kibana.
Sample flight data Sample data, visualizations, and dashboards for monitoring flight routes. Sample Flight Data Add sample data and assets to Elasticsearch and Kibana.
Sample eCommerce orders Sample data, visualizations, and dashboards for tracking eCommerce orders. Sample eCommerce Data Add sample data and assets to Elasticsearch and Kibana.
Upload a file Visualize data from a log file Upload a File Upload data from a CSV, TSV, JSON or other log file to Elasticsearch for analysis.

cc: @thomasneirynck @clintandrewhall

cchaos commented 3 years ago

If we're not going to be able to integrate the install functionality of sample data directly within the Integrations page, then I suggest having a single Sample data card that goes to the current tab "Add data" (or what will probably end up just being its own standalone page). Lets not make them have to choose which sample data set twice.

The current functionality is that each Sample Data card goes to a single link/page where they then actually decide which set to install.

cchaos commented 3 years ago

Oh and can I recommend an adjustment to the "Upload file" text to include the types of files that they support. Mainly I'm thinking about search. If a user types "CSV" into the search input, nothing will come up, yet the file uploader supports this.

So maybe something like:

Upload data from a CSV, TSV, JSON or other log file to Elasticsearch for analysis.

alexfrancoeur commented 3 years ago

If we're not going to be able to integrate the install functionality of sample data directly within the Integrations page, then I suggest having a single Sample data card that goes to the current tab "Add data" (or what will probably end up just being its own standalone page). Let's not make them have to choose which sample data set twice.

I'd be fine with this. I think we leaned more into multiple cards for discoverability. It looks like @thomasneirynck already merged the PR (https://github.com/elastic/kibana/pull/113200), so maybe we treat this as a nice to have or something we can clean up post FF?

Updated the text for these cards. @thomasneirynck @clintandrewhall do you think you'd be able to update the text for these three card types? I think the table below should suffice pending any changes we decide to make to sample data

Current Title Current Description New Title New Description
EMS Boundaries Administrative boundaries from Elastic Maps Service. Elastic Maps Service Download adminstrative boundaries from the Elastic Maps Service.
Sample web logs Sample data, visualizations, and dashboards for monitoring web logs. Sample Web Logs Add sample data and assets to Elasticsearch and Kibana.
Sample flight data Sample data, visualizations, and dashboards for monitoring flight routes. Sample Flight Data Add sample data and assets to Elasticsearch and Kibana.
Sample eCommerce orders Sample data, visualizations, and dashboards for tracking eCommerce orders. Sample eCommerce Data Add sample data and assets to Elasticsearch and Kibana.
Upload a file Visualize data from a log file Upload a File Upload data from a CSV, TSV, JSON or other log file to Elasticsearch for analysis.
alexfrancoeur commented 3 years ago

@thomasneirynck here's a finalize list of descriptions. If we don't have time to consolidate sample data cards into one, let's go with this.

New Title New Description
Elastic Maps Service Download adminstrative boundaries from the Elastic Maps Service.
Sample Web Logs Add sample data and assets to Elasticsearch and Kibana.
Sample Flight Data Add sample data and assets to Elasticsearch and Kibana.
Sample eCommerce Data Add sample data and assets to Elasticsearch and Kibana.
Upload a File Upload data from a CSV, TSV, JSON or other log file to Elasticsearch for analysis.

If we do, let's go with this.

New Title New Description
Elastic Maps Service Download adminstrative boundaries from the Elastic Maps Service.
Sample Data Add sample data and assets to Elasticsearch and Kibana.
Upload a File Upload data from a CSV, TSV, JSON or other log file to Elasticsearch for analysis.