-
Notifications
You must be signed in to change notification settings - Fork 917
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
Comments
Note: OUI Compliance is important but it also might not accurately reflect the entire OpenSearch Dashboard ecosystem. For example, 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. |
Yeah, @kavilla, I'll be adding an additional section for audits in OpenSearch Dashboards plugins that are managed by the OpenSearch project. |
Are we also auditing the dark mode? For example, opensearch-project/ml-commons-dashboards#206 |
@kavilla Did you already open an issue to document and audit dark mode? |
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.
advanced_settings
plugin #3963console
plugin #3966dev_tools
plugin #4160expressions
plugin #4122home
plugin #3945inspector
plugin #4084navigation
plugin #3962saved_objects
plugin #4161saved_objects_management
plugin #3967share
plugin #3965tile_map
plugin #4109vis_type_table
plugin #4162Core 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.
dashboard
plugin #4076dev_tools
plugin #4078data
plugin #4077discover
plugin #4079embeddable
plugin #4080expressions
plugin #4081index_pattern_management
plugin #4082input_control_vis
plugin #4083inspector
plugin #4084management
plugin #4085maps_legacy
plugin #4086opensearch_dashboards_legacy
plugin #4087opensearch_dashboards_overview
plugin #4088opensearch_dashboards_react
plugin #4089opensearch_ui_shared
plugin #4090region_map
plugin #4091saved_objects
plugin #4092tile_map
plugin #4093timeline
plugin #4094vis_builder
plugin #4095vis_default_editor
plugin #4096vis_type_markdown
plugin #4097vis_type_metric
plugin #4098vis_type_table
plugin #4099vis_type_tagcloud
plugin #4100vis_type_timeline
plugin #4101vis_type_timeseries
plugin #4102vis_type_vega
plugin #4103vis_type_vislib
plugin #4104visualizations
plugin #4105visualize
plugin #4106Core 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.
src/core/public/application
#4112src/core/public/chrome
#4113src/core/public/core_app
#4114src/core/public/overlays
#4115src/core/public/rendering
#4116src/core/public/styles
#4117The text was updated successfully, but these errors were encountered: