elastic / kibana

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

Create title and description based on guidelines for App Search integrations #114332

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

App Search example

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

Current Title Current Description New Title New Description
Paste JSON Paste an array of JSON documents. Ensure the JSON is valid and that each document object is less than 102400 bytes. App Search Create a search engine from JSON with App Search.
Upload a JSON file If you have a .json file, drag and drop or upload it. Ensure the JSON is valid and that each document object is less than 102400 bytes. App Search Create a search engine from JSON with App Search.
Index from API The documents API(opens in a new tab or window) can be used to add new documents to your engine, update documents, retrieve documents by id, and delete documents. There are a variety of client libraries(opens in a new tab or window) to help you get started. App Search Create a search engine from APIs with App Search.
Use the Crawler Easily index your website's content. To get started, enter your domain name, provide optional entry points and crawl rules, and we will handle the rest. App Search Create a search engine from our web crawler with App Search.

@zumwalt will follow up with the appropriate folks

elasticmachine commented 3 years ago

Pinging @elastic/app-search-frontend (Team:AppSearch)

richkuz commented 3 years ago

We're tracking the App Search work in https://github.com/elastic/app-search-team/issues/1995

zumwalt commented 3 years ago

I think we should disregard the "paste JSON" method here and proceed with these three:

snide commented 3 years ago

hey @zumwalt do you mind if we prefix the first two? "App Search API" and "App Search JSON". Otherwise they are pretty generically named in the list and might be misconstrued without the category. I'd like to also use the Enterprise Search logo to make this more clear.

(I can make the changes)

image

zumwalt commented 3 years ago

👍 That makes sense to me. Thanks @snide.