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

[Meta] OUI Compliance Audit Tracking #4111

Open
4 of 49 tasks
BSFishy opened this issue May 22, 2023 · 4 comments
Open
4 of 49 tasks

[Meta] OUI Compliance Audit Tracking #4111

BSFishy opened this issue May 22, 2023 · 4 comments
Assignees
Labels
OUI compliance Issues and PRs to maximize OUI usage and remove style and component hacks OUI Issues that require migration to OUI

Comments

@BSFishy
Copy link
Contributor

BSFishy commented May 22, 2023

This issue is to track the status of auditing each plugin and core service that has custom CSS. Ping @BSFishy if this list needs to be updated :)

Audits so far:

These are the results of audits. They typically have findings from the audits as well as action items to remediate anything found in the audits.

Core plugins compliance tracking issues:

These are issues to track who is performing each audit. They follow a template linking back to issue #3945 as reference for how to perform the audit and list out relevant files to the audit that may be useful.

Core service compliance tracking issues:

These are tracking issues for auditing core services. They are similar to the tracking issues for plugins, but focus on services that are core to Dashboards, rather than core Dashboards plugins. Note that these are core services, which may be involved with the implementation and inclusion of OUI styles and themes. Since these are core services, the conclusions of them might actually not involve any additional work.

@kavilla
Copy link
Member

kavilla commented May 31, 2023

Note: OUI Compliance is important but it also might not accurately reflect the entire OpenSearch Dashboard ecosystem.

For example,
opensearch-project/dashboards-observability#484

Plugins are able to modify global styles or update OUI variables that impact the entire ecosystem presented in OpenSearch Dashboards. Visual regressions can occur outside of Core OpenSearch Dashboards.

We should add CI checks that catches potential updates downstreams while building OpenSearch Dashboards (or in here) that enables systems to check if OUI variables/styles were modified.

This also showcases that OUI compliance is the per-cursor to usability cohesion. But external plugins must also be audited for look and feel cohesion.

@joshuarrrr
Copy link
Member

Yeah, @kavilla, I'll be adding an additional section for audits in OpenSearch Dashboards plugins that are managed by the OpenSearch project.

@joshuarrrr joshuarrrr changed the title [META] OUI Compliance Audit Tracking [Initiative] OUI Compliance Audit Tracking May 31, 2023
@joshuarrrr joshuarrrr changed the title [Initiative] OUI Compliance Audit Tracking [Meta] OUI Compliance Audit Tracking May 31, 2023
@joshuarrrr joshuarrrr added the OUI compliance Issues and PRs to maximize OUI usage and remove style and component hacks label Jun 1, 2023
@kavilla
Copy link
Member

kavilla commented Jun 1, 2023

Are we also auditing the dark mode?

For example, opensearch-project/ml-commons-dashboards#206

@joshuarrrr
Copy link
Member

@kavilla Did you already open an issue to document and audit dark mode?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OUI compliance Issues and PRs to maximize OUI usage and remove style and component hacks OUI Issues that require migration to OUI
Projects
Status: In Progress
Development

No branches or pull requests

4 participants