-
Notifications
You must be signed in to change notification settings - Fork 893
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 theme compliance for plugins - phase 1 #4291
Comments
https://github.com/opensearch-project/dashboards-i18n has no views or UI, so can be skipped in future campaigns. |
@wbeckler Can we update the table, and relabel for 2.11? |
Today is code freeze - any remaining compliance will be in 2.11. |
Removing release label. While all OpenSearch Dashboards plugins are still encouraged to resolve these compliance issues, to avoid disruptive OUI or theme related changes in the future, we'll instead prioritize resolving all known issues in opensearch-project/oui#895 |
Introduction
As part of a strategic initiative, the OpenSearch project is planning significant updates to the look and feel of OpenSearch Dashboards. To make this process efficient and maintainable, we're centralizing and consolidating UI patterns in the OUI library, which means that additional styling, overrides, and custom components in OpenSearch Dashboards and OpenSearch Dashboards plugins will be phased out.
This issues is to track phase 1 of OUI theme plugin compliance, which will involve changes to OUI typography and color SASS variables (for both dark and light mode). Final values are still TBD, but research values can be tracked in opensearch-project/oui#807.
Key dates
We expect to ship the updated theme as an experimental/optional theme in the 2.9 release (code freeze July 11, 2023), and to make it the default theme in 2.10 (code freeze August 22, 2023). In order for the UX time to review and approve all plugins, actions should be completed by August 6, 2023.
Actions required
Identify
The OpenSearch Dashboards team has created some scripts and tooling that may assist your efforts to identify typographic and color styles:
Tracking issues
FAQs
Once these actions are completed, is a plugin fully OUI compliant?
No. Phase 1 is limited to typographic and color values, but we'll have additional phases as we move toward [the complete design vision](https://github.com//issues/4298).
How can I avoid future OUI compliance campaigns?
The best way to prevent future work and refactoring is to only use OUI React components, following the patterns in [the documentation website](https://oui.opensearch.org/1.0/#/). This means avoiding SASS, CSS, and inline styles altogether. If you believe your feature or design requires properties or components unavailable in OUI, please work with your UX partner to reconsider the design or [open issues in the OUI repository](https://github.com/opensearch-project/oui/issues/new/choose) that explain the use case and need.
The text was updated successfully, but these errors were encountered: