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.

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

Provide documentation for Analyst Experience components #152553

Open
dej611 opened this issue Mar 2, 2023 · 5 comments
Open

Provide documentation for Analyst Experience components #152553

dej611 opened this issue Mar 2, 2023 · 5 comments
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

Comments

@dej611
Copy link
Contributor

dej611 commented Mar 2, 2023

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

@dej611 dej611 added enhancement New value added to drive a business result Team:Visualizations Visualization editors, elastic-charts and infrastructure Feature:Lens Feature:Storybook documentation labels Mar 2, 2023
@elasticmachine
Copy link
Contributor

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

@drewdaemon drewdaemon added the impact:needs-assessment Product and/or Engineering needs to evaluate the impact of the change. label Mar 2, 2023
@clintandrewhall
Copy link
Contributor

This PoC may be of interest.

#150480

cc: @rshen91 @daveyholler

@timductive timductive added impact:high Addressing this issue will have a high 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 Mar 9, 2023
@timductive timductive changed the title [Lens][Storybook] Provide some storybook documentation for LensEmbeddable [Lens][Storybook] Provide documentation for Analyst Experience components Mar 9, 2023
@timductive timductive added discuss Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas Team:DataDiscovery Discover App Team (Document Explorer, Saved Search, Surrounding documents, Graph) labels Mar 9, 2023
@elasticmachine
Copy link
Contributor

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

@timductive timductive changed the title [Lens][Storybook] Provide documentation for Analyst Experience components Provide documentation for Analyst Experience components Mar 9, 2023
@elasticmachine
Copy link
Contributor

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

@davismcphee davismcphee added the loe:needs-research This issue requires some research before it can be worked on or estimated label Sep 8, 2023
@kertal
Copy link
Member

kertal commented Sep 3, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

7 participants