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.

Sign up for GitHub

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

Jump to bottom

Add inline help/documentation to Discover #114271

Closed
2 of 10 tasks
Tracked by #170754
rayafratkina opened this issue Oct 7, 2021 · 3 comments
Closed
2 of 10 tasks
Tracked by #170754

Add inline help/documentation to Discover #114271

rayafratkina opened this issue Oct 7, 2021 · 3 comments
Labels
enhancement New value added to drive a business result Feature:Discover Discover Application Icebox impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. loe:x-large Extra Large Level of Effort Team:DataDiscovery Discover, search (e.g. data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL. Team:Docs

Comments

@rayafratkina
Copy link
Contributor

rayafratkina commented Oct 7, 2021 •
edited by gchaps
Loading

Similar to advanced documentation in Lens, we should add pop-over docs to Discover to cover key concepts of the UX. In addition to helping them use Discover, this is a great opportunity to help introduce our users to Elastic concepts.

Some documentation we should consider including

  • Explanation of field types and meaning of icons (specifically also keyword vs text)
  • Limitations of current field list (sampling)
  • Explanation of _source
  • Explanation of _score
  • How to turn features on/off with Labs
  • How to use the new table
  • How to visualize data in Lens
  • How to provide in-app feedback
  • Explanation of ignored field values
  • Helper text for all advanced settings

A key result here would be to have inline help for each of the top 10 most clicked areas of Discover.
@rayafratkina rayafratkina added Team:Docs Feature:Discover Discover Application triage_needed Team:DataDiscovery Discover, search (e.g. data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL. labels Oct 7, 2021
@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-data-discovery (Team:DataDiscovery)

@timroes timroes added the enhancement New value added to drive a business result label Oct 12, 2021
@timroes timroes mentioned this issue Oct 14, 2021
Merged
7 tasks
@Heenawter Heenawter mentioned this issue Jan 28, 2022
Closed
@kertal kertal added the impact:needs-assessment Product and/or Engineering needs to evaluate the impact of the change. label Jan 31, 2023
@KOTungseth KOTungseth added loe:x-large Extra Large Level of Effort impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. and removed impact:needs-assessment Product and/or Engineering needs to evaluate the impact of the change. labels Feb 7, 2023
@kertal kertal mentioned this issue Nov 7, 2023
Open
@kertal
Copy link
Member

kertal commented Nov 27, 2023

Closing this because it's not planned to be resolved in the foreseeable future. It will be tracked in our Icebox and will be re-opened if our priorities change. Feel free to re-open if you think it should be melted sooner.

@kertal kertal closed this as not planned Won't fix, can't repro, duplicate, stale Nov 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New value added to drive a business result Feature:Discover Discover Application Icebox impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. loe:x-large Extra Large Level of Effort Team:DataDiscovery Discover, search (e.g. data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL. Team:Docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@kertal @timroes @elasticmachine @rayafratkina @KOTungseth