opensearch-project / ux

Public repository for OpenSearch UX. Tracks issues, epics and workstreams related to improving the user experience, usability and accessibility of OpenSearch core, dashboards and related plugins.
Apache License 2.0
4 stars 5 forks source link

[VisBuilder] Naming Conventions for VisBuilder & Saved Objects #49

Open KrooshalUX opened 1 year ago

KrooshalUX commented 1 year ago

General guidance:

Referring to the saved object created by Vis builder: Chart Type Icon + Chart Type (Pie, Area, etc) Name + Experimental badge (OuiBetaBadge subdued style, using "icontype=beaker")

Screen Shot 2022-10-21 at 11 46 58 AM

Vis builder saved object icon tip: Chart Type (VisBuilder)

Create/Edit visualization: Visualization (Stable), Visualization (VisBuilder) + Experimental badge (OuiBadge)


More detail:

VisBuilder is a method to build visualization objects. Therefore when referring to a saved object within OSD that was created with Visualization Builder, please use "Visualization" in place of "VisBuilder" or previously "Wizard".

Examples: Replace "wizard" with "Visualization (VisBuilder)" in the following instances of wizard in this UI:

Screen Shot 2022-10-20 at 5 06 17 PM Screen Shot 2022-10-21 at 10 59 42 AM Screen Shot 2022-10-21 at 11 09 57 AM Screen Shot 2022-10-21 at 11 10 40 AM

Because we have two creation methods for visualizations - and one that is still "experimental", my recommendation for "create" would be to clarify entry points into both visualization creation methods. Therefore, in the following UI, the options within the dropdown would read : "Visualization (Stable)" "Visualization (VisBuilder) + Experimental badge " Where experimental is written as an OuiBadge in primary state (blue)

Adding a tool tip on mouse over for Visualization (Experimental) listing the available char types is recommended as well.

Note that this is a temporary/short term solution as the UX team works on a project proposed for post-2.4 release, to improve the entry points flows for the VisBuilder.