elastic / kibana

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

Provide documentation for Analyst Experience components #152553

Open dej611 opened 1 year ago

dej611 commented 1 year ago

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:

docs_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:

Screenshot 2023-03-02 at 11 48 12
elasticmachine commented 1 year ago

Pinging @elastic/kibana-visualizations @elastic/kibana-visualizations-external (Team:Visualizations)

clintandrewhall commented 1 year ago

This PoC may be of interest.

https://github.com/elastic/kibana/pull/150480

cc: @rshen91 @daveyholler

elasticmachine commented 1 year ago

Pinging @elastic/kibana-presentation (Team:Presentation)

elasticmachine commented 1 year ago

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

kertal commented 1 month ago

cleaning up a bit, it's been a while, should we keep this open?