Provide documentation for Analyst Experience components #152553
Labels
discuss
documentation
enhancement
New value added to drive a business result
Feature:Lens
impact:high
Addressing this issue will have a high level of impact on the quality/strength of our product.
loe:needs-research
This issue requires some research before it can be worked on or estimated
Team:DataDiscovery
Discover App Team (Document Explorer, Saved Search, Surrounding documents, Graph)
Team:Presentation
Presentation Team for Dashboard, Input Controls, and Canvas
Team:Visualizations
Visualization editors, elastic-charts and infrastructure
Problem: We need a way to showcase all of our components in one place for all of Analyst Experience. Solving this problem is important for the scaleability and adoption. The following is just a proposal and the actual implementation needs to be discussed.
Describe the feature:
Leverage the current storybook system in kibana to provide better
LensEmbeddable
documentation to consumers.I've put together a quick example of the doc shape using the unified search stories:
So the idea is to put the LensEmbeddable within free text as in the EUI documentation with available source code to copy and paste directly.
Ideally some mocks will be required to work, and the
unified_search
ones I think are a good starting point (others can be inferred from Lens testing, and probably will need to more some expressions - i.e. data fetching).There's already another example which can work as inspiration from the
infra
team:The text was updated successfully, but these errors were encountered: