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

[Add Data] Design input for Beta modules #17679

Closed
alexfrancoeur opened this issue Apr 12, 2018 · 16 comments · Fixed by #20049
Closed

[Add Data] Design input for Beta modules #17679

alexfrancoeur opened this issue Apr 12, 2018 · 16 comments · Fixed by #20049
Labels
Feature:Add Data Add Data and sample data feature on Home Team:Platform-Design Team Label for Kibana Design Team. Support the Analyze group of plugins. Team:Visualizations Visualization editors, elastic-charts and infrastructure

Comments

@alexfrancoeur
Copy link

We have a number of Beats modules that are currently flagged as beta. This means that they are subject to change and may not always have a dashboard associated with it. The team is currently targeting 6.4 to introduce these beta modules as new tutorials in the Add Data UI. I think we should spend a little bit of time trying to figure out how best to represent the beta state of these modules in the UI.

@snide @cchaos @gchaps any chance we can could get some design / messaging input?

Some concepts from @ruflin and @tsg can be found below:

image

image

cc: @nreese

@alexfrancoeur alexfrancoeur added Team:Platform-Design Team Label for Kibana Design Team. Support the Analyze group of plugins. Feature:Add Data Add Data and sample data feature on Home :Sharing labels Apr 12, 2018
@cchaos
Copy link
Contributor

cchaos commented Apr 17, 2018

Quick question, is "Beta" the definite word here or is the signifier up for discussion? Not that I have any better ideas, jw.

@alexfrancoeur
Copy link
Author

alexfrancoeur commented Apr 18, 2018 via email

@ruflin
Copy link
Contributor

ruflin commented Apr 18, 2018

Yes, the 3 stages we have are experimental, beta, ga. But experimental will not make it in Kibana home as it means these modules could still be removed.

@cchaos
Copy link
Contributor

cchaos commented Apr 19, 2018

So we're leaning towards one of these approaches (and highly suggest using the EuiCard system to create this grid). The main question is how obvious does it need to be?

screen shot 2018-04-19 at 16 13 45 pm

Also, one more suggestion would be too add the word "Screenshot" to "Coming soon" that's overlaid on the screenshot, as it's not clear if the whole Add data is coming soon or just that image.

@ruflin
Copy link
Contributor

ruflin commented Apr 20, 2018

This is how the beta message looks in our docs: https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-module-ceph.html I would say it's pretty obvious but still most people skip it or never get to the docs. We also log it in case such modules are used but also not sure how many people see it.

I'm torn between the two. I like the option on the left because we finally have a place to make it obvious to the user that something is beta. On the other hand I would prefer to have as many people as possible to test the modules before going GA so in the right one it much more disappears.

The reason I'm leading toward the left one is as it gives us the opportunity to also ask the user for feedback about the beta module as he is already aware of it. And I'm not sure how many people will not try the module because something is beta. How do we indicate the beta on the page itself?

For the Screenshot: It should probably be "Dashboards coming soon" as the screenshot is missing because there are no dashboards.

@cchaos
Copy link
Contributor

cchaos commented Apr 20, 2018

@ruflin Got it. I think we were all leaning towards that one as well. What I would then do is utilize tooltips to explain the Beta label and express that we'd still like feedback/testers. As for the in-page indication, I'd stick with the same paradigm and use the label again inline with the title (again with the explanation in a tooltip).

screen shot 2018-04-20 at 11 49 58 am

As for the screenshot, I guess I'm confused about what it is or what it will be. I might then lean towards leaving that out completely as it could confuse people. Otherwise, you may want to consult @gchaps about the language for it (and the tooltip).

@alexfrancoeur
Copy link
Author

I also like the choice on the left where we're calling beta out a bit more, as long as the tooltip provides a good description of what exactly that means.

@ruflin did you want to provide a way to give feedback? Right now we use this banner for visualizations. Not the best looking warning, but we do direct users to GitHub.

image

I'm wondering if we introduce this to the tutorial list view, if we now should replace the beaker for experimental on the visualization page / list view as well. We could us "Lab" as an experimental tag.

screen shot 2018-04-20 at 1 34 20 pm

screen shot 2018-04-20 at 1 36 42 pm

@ruflin
Copy link
Contributor

ruflin commented Apr 23, 2018

I really like the tooltips that describe what "beta" means and allows us to add info here.

@alexfrancoeur I haven't really thought through the feedback part yet as this is a possibility for Beats we never had before and is really exciting. In general we direct users to discuss for Feedback and questions. But as this is module specific the most common question we have: Did we pick the right fields from the metric endpoints and has the user enough information? Did we create the right metricsets? I'm not sure what would be the best way to gather this feedback.

@alexfrancoeur
Copy link
Author

alexfrancoeur commented Apr 23, 2018

@ruflin right now, we can provide a generic link for the view with a banner. I'm not sure if this is the best approach for these tutorials, but we may be able to take advantage of the manifest file here. If we're generically going to be adding a way to make a tutorial "beta", it's not out of the question to add a feedback link in this case. This way, it will be specific for each tutorial. We can surface in the tutorial however design decides best. If you can customize the URL, I wonder if it's worth pointing to a specific discuss issue. Maybe create one for each beta module where we list some generic questions we'd like feedback on but open it for users to provide their own? Or we could take advantage of something like a google form. I believe we're still using that in Canvas today (though that may change when we move out of Technology Preview)

@ruflin
Copy link
Contributor

ruflin commented Apr 23, 2018

Let's skip the feedback part for now to remove the complexity. I'm pretty sure we can still add that later and also learn from what others did so far.

In general I like the idea of sending people to a "place" where they know exactly what they have to answer.

@cchaos
Copy link
Contributor

cchaos commented Apr 26, 2018

EUI now has EuiBetaBadge elastic/eui#705

You'll just need to wait for a new release to be made 😃

@alexfrancoeur
Copy link
Author

@elastic/kibana-visualizations do we want to adopt this for lab / experimental visualizations ^^

@ruflin
Copy link
Contributor

ruflin commented May 2, 2018

@cchaos Nice. Sounds like I should start following EUI releases. Seems they are rather frequent.

@timroes
Copy link
Contributor

timroes commented May 2, 2018

@alexfrancoeur I surly like that design a lot. I think we should adopt that when moving the visualization creation wizard to EUI.

@alexfrancoeur
Copy link
Author

@timroes ++ sounds good

@ruflin
Copy link
Contributor

ruflin commented Jun 26, 2018

@nreese Thanks for your work on this. I opened #20223 as a first module example to be in beta.

@timroes timroes added Team:Visualizations Visualization editors, elastic-charts and infrastructure and removed :Sharing labels Sep 13, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Add Data Add Data and sample data feature on Home Team:Platform-Design Team Label for Kibana Design Team. Support the Analyze group of plugins. Team:Visualizations Visualization editors, elastic-charts and infrastructure
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants