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 theme compliance for plugins - phase 1 #4291

Open
3 of 15 tasks
joshuarrrr opened this issue Jun 15, 2023 · 5 comments
Open
3 of 15 tasks

[META] OUI theme compliance for plugins - phase 1 #4291

joshuarrrr opened this issue Jun 15, 2023 · 5 comments
Labels
OUI compliance Issues and PRs to maximize OUI usage and remove style and component hacks

Comments

@joshuarrrr
Copy link
Member

joshuarrrr commented Jun 15, 2023

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

  1. Acknowledge the issue by adding an assignee who will serve as a point-of-contact
  2. Provide screenshots and navigation instructions for important views and screens in your plugin or application. This will assist with both manual and automatic validation of compliance
  3. Identify all typographic properties and styles (SASS and inline styles, JS props)
  4. Create issues to mitigate typographic styles not inherited from OUI components or SASS variables
  5. Identify all color values, including visualization colors and palettes (SASS and inline styles, JS props)
  6. Create issues to mitigate typographic styles not inherited from OUI components or SASS variables
  7. Resolve all mitigation issues
  8. Validate and test plugin with updated OUI theme

Identify

The OpenSearch Dashboards team has created some scripts and tooling that may assist your efforts to identify typographic and color styles:

  1. Search for typographic properties
  2. Search for color values

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.

@joshuarrrr joshuarrrr added OUI compliance Issues and PRs to maximize OUI usage and remove style and component hacks v2.10.0 labels Jun 16, 2023
@joshuarrrr
Copy link
Member Author

https://github.com/opensearch-project/dashboards-i18n has no views or UI, so can be skipped in future campaigns.

@joshuarrrr joshuarrrr moved this to In Progress in Look & Feel Jun 23, 2023
@wbeckler
Copy link

wbeckler commented Jun 29, 2023

plugin status
opensearch-project/alerting-dashboards-plugin#575 unacknowledged, untriaged
opensearch-project/anomaly-detection-dashboards-plugin#510 unassigned, targeted to 2.10
https://github.com/opensearch-project/dashboards-catalog/issues/9 unacknowledged, untriaged, repo is missing untriaged workflow
opensearch-project/dashboards-maps#425 unassigned, targeted to 2.10
opensearch-project/dashboards-notifications#60 unacknowledged, untriaged
opensearch-project/dashboards-observability#541 unacknowledged, unassigned
opensearch-project/dashboards-query-workbench#83 unacknowledged, untriaged
opensearch-project/dashboards-reporting#127 unacknowledged, untriaged
opensearch-project/dashboards-search-relevance#223 assigned, no release target yet
opensearch-project/dashboards-visualizations#190 unacknowledged, untriaged
opensearch-project/index-management-dashboards-plugin#793 unacknowledged, untriaged
opensearch-project/security-analytics-dashboards-plugin#633 assigned, no release target yet

@joshuarrrr
Copy link
Member Author

@wbeckler Can we update the table, and relabel for 2.11?

@joshuarrrr
Copy link
Member Author

Today is code freeze - any remaining compliance will be in 2.11.

@joshuarrrr
Copy link
Member Author

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

@joshuarrrr joshuarrrr moved this from In Progress to Meta in Look & Feel Sep 15, 2023
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
Projects
Status: Meta
Development

No branches or pull requests

2 participants