[META] Dashboards & Plugins OUI Compliance

[seanneumann]

We want to eventually do a complete end-to-end redesign of OpenSearch Dashboards. In order for this redesign to be scalable and consistent, it will leverage themes provided by OUI.

Today, OpenSearch Dashboards and OpenSearch Dashboard plugins don't always use OUI, or use it properly (as documented in the usage guidelines). There are many UI implementations that use overrides or custom styles / components. In order for theming updates to be applied correctly and consistently, a prerequisite is to remove any potentially conflicting styles and components.

Our goal is to make styling and component definition the sole responsibility of OUI. An idealized outcome would be to remove all inline styles, classes, and stylesheets from OpenSearch Dashboards.

Achieving and maintaining OUI compliance will have several work streams:

• [OUI compliance] Initial re-theming #4239
• [OUI compliance] Audit OUI compliance in OpenSearch Dashboards
• [OUI compliance] Mitigate/remove styling customizations in OpenSearch Dashboards #4254
• [OUI compliance] Update OpenSearch Dashboards visualization platforms to use OUI styles and themes
• [OUI compliance] Create automation and tooling to identify and prevent non-compliance #4246
• [OUI compliance] Improve/extend OUI components and usage documentation to make compliance easier
• [OUI compliance] Audit OUI compliance in dashboard plugins
• [OUI compliance] Mitigate/remove styling customizations in dashboard plugins

The general lifecycle of audits (per plugin or core service):

flowchart TD
a["Audit"] --> r1["Recommendation 1"]
    a --> r2["Recommendation 2"]
    a --> rellip["..."]
    a --> rn["Recommendation N"]
    r1 --> m1["Mitigation 1"]
    r2 --> m2["Mitigation 2"]
    rn --> mn["Mitigation N"]
    r1 --> rr1["Review and align"]
    rr1 --> r1
    r2 --> rr2["Review and align"]
    rr2 --> r2
    rn --> rrn["Review and align"]
    rrn --> rn
    rellip --> mellip["..."]
    m1 --> ux["UX Review and Validation"]
    m2 --> ux
    mellip --> ux
    mn --> ux
    ux --> cc["Compliance Complete"]

Loading

In addition to this META issue, we will be tracking OUI compliance changes in this GitHub Project. We are also labeling issues with OUI compliance Issues and PRs to maximize OUI usage and remove style and component hacks .