From 36f8492617306f0087a50f6ac37ef60a28afd52d Mon Sep 17 00:00:00 2001 From: Francisco Date: Wed, 13 Mar 2024 15:20:24 +0100 Subject: [PATCH 01/14] Project proposal --- .../20240313-project_proposal_dark_mode.md | 81 +++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md diff --git a/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md b/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md new file mode 100644 index 00000000000..8f5df88c735 --- /dev/null +++ b/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md @@ -0,0 +1,81 @@ +# 2024-03-13 Project Proposal + +**Author**: @fcoveram + +## Reviewers + + + +- [ ] @obulat +- [ ] @zackkrida + +## Project summary + + + +Include a feature that changes the UI from light to a dark color scheme. + +### Motivation + +Dark mode is a customization level that is in the spirit of adapting the UI to +people’s contexts. The benefits span a11y, personal preferences set on the +devices, energy efficiency in devices, and an alternative browsing experience of +visual content due to the background contrast. + +## Goals + + + +Refine Search Experience + +## Requirements + + + +1. Design documentation of pages and UI components in the Design Library and any + other additional Figma files. +2. Design documentation of transition from current to new frontend + implementation. + +## Success + + + +- Add the dark theme to the site by allowing visitors to change the UI through + three options: Light theme, Dark theme, or follow device setting. +- Document the dark variant of every UI element in both the Design Library and + Storybook. + +## Participants and stakeholders + + + +- Lead: @fcoveram +- Design: @fcoveram +- Implementation: TBD + +## Infrastructure + + + +TBD + +## Accessibility + + + +- Follow the advisor of WCAG 2.2 to meet AA. Put special attention to the + [Perceivable section](https://www.w3.org/WAI/WCAG22/quickref/?currentsidebar=%23col_overview&levels=aaa&showtechniques=321#principle1). + +## Marketing + + + +Since the project involves visual changes across the site, there is a marketing +opportunity to introduce the benefits of the UI’s dark theme. + +## Required implementation plans + + + +Frontend implementation plan. From e0125c907154632671bbcca17c12aa13c291482e Mon Sep 17 00:00:00 2001 From: Francisco Date: Thu, 14 Mar 2024 18:23:07 +0100 Subject: [PATCH 02/14] Adding index.md file into the folder --- documentation/projects/proposals/dark_mode/index.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 documentation/projects/proposals/dark_mode/index.md diff --git a/documentation/projects/proposals/dark_mode/index.md b/documentation/projects/proposals/dark_mode/index.md new file mode 100644 index 00000000000..c10de4d133d --- /dev/null +++ b/documentation/projects/proposals/dark_mode/index.md @@ -0,0 +1,5 @@ +# Dark Mode + +:titlesonly: :glob: + +- From 09244f37c2e10fa25ddff6c28fda4ac28daff0e4 Mon Sep 17 00:00:00 2001 From: Olga Bulat Date: Thu, 14 Mar 2024 21:24:30 +0300 Subject: [PATCH 03/14] Update index.md --- documentation/projects/proposals/dark_mode/index.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/documentation/projects/proposals/dark_mode/index.md b/documentation/projects/proposals/dark_mode/index.md index c10de4d133d..d73ae5163be 100644 --- a/documentation/projects/proposals/dark_mode/index.md +++ b/documentation/projects/proposals/dark_mode/index.md @@ -1,5 +1,8 @@ # Dark Mode -:titlesonly: :glob: +```{toctree} +:titlesonly: +:glob: -- +* +``` From 94016fc98a4355ce38e6be1ed8233465c9b58b60 Mon Sep 17 00:00:00 2001 From: Francisco Date: Tue, 19 Mar 2024 10:48:58 +0100 Subject: [PATCH 04/14] Update documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md Replacing word "people" with "user" Co-authored-by: zack <6351754+zackkrida@users.noreply.github.com> --- .../proposals/dark_mode/20240313-project_proposal_dark_mode.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md b/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md index 8f5df88c735..e542f9de56b 100644 --- a/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md +++ b/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md @@ -18,7 +18,7 @@ Include a feature that changes the UI from light to a dark color scheme. ### Motivation Dark mode is a customization level that is in the spirit of adapting the UI to -people’s contexts. The benefits span a11y, personal preferences set on the +user's contexts. The benefits span a11y, personal preferences set on the devices, energy efficiency in devices, and an alternative browsing experience of visual content due to the background contrast. From d79994531b30e392c75c4d1740d126f277916038 Mon Sep 17 00:00:00 2001 From: Francisco Date: Tue, 19 Mar 2024 11:08:40 +0100 Subject: [PATCH 05/14] Update documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md Adding details about infrastructure changes Co-authored-by: zack <6351754+zackkrida@users.noreply.github.com> --- .../proposals/dark_mode/20240313-project_proposal_dark_mode.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md b/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md index e542f9de56b..05566ebd36b 100644 --- a/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md +++ b/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md @@ -58,7 +58,7 @@ Refine Search Experience -TBD +This project only concerns frontend user interface code, and swapping colors. It should not require any changes to our infrastructure. ## Accessibility From 4ee163716ac9098862da2792417325435d216b06 Mon Sep 17 00:00:00 2001 From: Francisco Date: Tue, 19 Mar 2024 11:33:27 +0100 Subject: [PATCH 06/14] Moving content from Success to Requirements and including more --- .../20240313-project_proposal_dark_mode.md | 20 ++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md b/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md index 05566ebd36b..a5082b88622 100644 --- a/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md +++ b/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md @@ -32,20 +32,21 @@ Refine Search Experience -1. Design documentation of pages and UI components in the Design Library and any +1. Add the dark theme to the site and set the Light theme as default. +2. Allow visitors to change the UI in an reachable manner from the whole site + through three options: Light theme, Dark theme, or follow device setting. +3. Design a dark theme preserving the brand identity. +4. Design a dark theme that meet the color contrast requirements pointed out in + the accessibility section below. +5. Document the design of pages and UI components in the Design Library and any other additional Figma files. -2. Design documentation of transition from current to new frontend - implementation. +6. Document the dark variant of every UI element on Storybook. +7. Document the transition from current to new frontend implementation. ## Success -- Add the dark theme to the site by allowing visitors to change the UI through - three options: Light theme, Dark theme, or follow device setting. -- Document the dark variant of every UI element in both the Design Library and - Storybook. - ## Participants and stakeholders @@ -58,7 +59,8 @@ Refine Search Experience -This project only concerns frontend user interface code, and swapping colors. It should not require any changes to our infrastructure. +This project only concerns frontend user interface code, and swapping colors. It +should not require any changes to our infrastructure. ## Accessibility From e1bfd1710ae3fbd0bf6cf6cce9126fc9777dfa07 Mon Sep 17 00:00:00 2001 From: Francisco Date: Wed, 20 Mar 2024 12:09:16 +0100 Subject: [PATCH 07/14] More details in the accessibility section --- .../20240313-project_proposal_dark_mode.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md b/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md index a5082b88622..e0cd95d537e 100644 --- a/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md +++ b/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md @@ -66,8 +66,21 @@ should not require any changes to our infrastructure. -- Follow the advisor of WCAG 2.2 to meet AA. Put special attention to the - [Perceivable section](https://www.w3.org/WAI/WCAG22/quickref/?currentsidebar=%23col_overview&levels=aaa&showtechniques=321#principle1). +Shifting the UI theme should be actioned through a mix of one or more of the +following current elements: + +- VCheckbox +- VRadio +- VItemGroup +- VSelectField +- VPopover +- VButton +- VIconButton + +The designs of pages and components need to meet the contrast color requirements +described in WCAG 2.2 to meet AA. See the +[Perceivable section](https://www.w3.org/WAI/WCAG22/quickref/?currentsidebar=%23col_overview&levels=aaa&showtechniques=321#principle1) +of the guideline for more context. ## Marketing From 6489f9151b5b6d535ce214f3d1ddd2f66d8edd05 Mon Sep 17 00:00:00 2001 From: Francisco Date: Thu, 21 Mar 2024 16:02:34 +0100 Subject: [PATCH 08/14] New sentence in Success section --- .../proposals/dark_mode/20240313-project_proposal_dark_mode.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md b/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md index e0cd95d537e..29e0177c27c 100644 --- a/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md +++ b/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md @@ -42,11 +42,14 @@ Refine Search Experience other additional Figma files. 6. Document the dark variant of every UI element on Storybook. 7. Document the transition from current to new frontend implementation. +8. Include an analytic event to record how users utilize the functionality. ## Success +The use of this feature will be recorded and analyzed to assess its success. + ## Participants and stakeholders From 05342f0ec31f497216b090cbcf180718e06459b9 Mon Sep 17 00:00:00 2001 From: Francisco Date: Thu, 21 Mar 2024 16:05:53 +0100 Subject: [PATCH 09/14] New description in Marketing section --- .../dark_mode/20240313-project_proposal_dark_mode.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md b/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md index 29e0177c27c..967b6b48ce9 100644 --- a/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md +++ b/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md @@ -87,10 +87,10 @@ of the guideline for more context. ## Marketing - + -Since the project involves visual changes across the site, there is a marketing -opportunity to introduce the benefits of the UI’s dark theme. +An announcement showing the functionality will be created in conjunction with +marketing team based on their existing workflows. ## Required implementation plans From f03adcb0642c7c74c278b75cfdd565d88b8454eb Mon Sep 17 00:00:00 2001 From: Francisco Date: Thu, 21 Mar 2024 16:07:11 +0100 Subject: [PATCH 10/14] Adding openverse frontend members as implementers --- .../proposals/dark_mode/20240313-project_proposal_dark_mode.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md b/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md index 967b6b48ce9..9fe5b5d8919 100644 --- a/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md +++ b/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md @@ -56,7 +56,7 @@ The use of this feature will be recorded and analyzed to assess its success. - Lead: @fcoveram - Design: @fcoveram -- Implementation: TBD +- Implementation: @WordPress/openverse-frontend ## Infrastructure From 6d21f523487f48039d1066a1c7c46a8fa4023174 Mon Sep 17 00:00:00 2001 From: Francisco Date: Fri, 22 Mar 2024 15:42:14 +0100 Subject: [PATCH 11/14] New requirement and rationale of light theme as default --- .../20240313-project_proposal_dark_mode.md | 23 +++++++++++-------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md b/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md index 9fe5b5d8919..bcec91f0e1d 100644 --- a/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md +++ b/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md @@ -32,23 +32,28 @@ Refine Search Experience -1. Add the dark theme to the site and set the Light theme as default. -2. Allow visitors to change the UI in an reachable manner from the whole site +1. Add the dark theme to the site and set the Light theme as default. The reason + comes from not changing the site settings without user consent through an + action. +2. Introduce the feature to users on the site once deployed. +3. Allow visitors to change the UI in an reachable manner from the whole site through three options: Light theme, Dark theme, or follow device setting. -3. Design a dark theme preserving the brand identity. -4. Design a dark theme that meet the color contrast requirements pointed out in +4. Design a dark theme preserving the brand identity. +5. Design a dark theme that meet the color contrast requirements pointed out in the accessibility section below. -5. Document the design of pages and UI components in the Design Library and any +6. Document the design of pages and UI components in the Design Library and any other additional Figma files. -6. Document the dark variant of every UI element on Storybook. -7. Document the transition from current to new frontend implementation. -8. Include an analytic event to record how users utilize the functionality. +7. Document the dark variant of every UI element on Storybook. +8. Document the transition from current to new frontend implementation. +9. Include an analytic event to record how users utilize the functionality. ## Success -The use of this feature will be recorded and analyzed to assess its success. +- The use of this feature will be recorded and analyzed to assess its success. +- Evaluate the color contrast with an automated tool and a revision from + contributors. ## Participants and stakeholders From a1aa73e85ae63628e56cfcc0bf4f7f84e5fab575 Mon Sep 17 00:00:00 2001 From: Francisco Date: Fri, 22 Mar 2024 16:41:15 +0100 Subject: [PATCH 12/14] Adding Olga as implementer --- .../proposals/dark_mode/20240313-project_proposal_dark_mode.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md b/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md index bcec91f0e1d..71fbd6261a7 100644 --- a/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md +++ b/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md @@ -61,7 +61,7 @@ Refine Search Experience - Lead: @fcoveram - Design: @fcoveram -- Implementation: @WordPress/openverse-frontend +- Implementation: @obulat ## Infrastructure From 996bca4777ee4560d63a2fdc86ec1a1639ab1616 Mon Sep 17 00:00:00 2001 From: Francisco Date: Mon, 25 Mar 2024 15:27:04 +0100 Subject: [PATCH 13/14] Zack approval of the document Co-authored-by: zack <6351754+zackkrida@users.noreply.github.com> --- .../proposals/dark_mode/20240313-project_proposal_dark_mode.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md b/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md index 71fbd6261a7..8c10d34aa64 100644 --- a/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md +++ b/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md @@ -7,7 +7,7 @@ - [ ] @obulat -- [ ] @zackkrida +- [x] @zackkrida ## Project summary From 5afb550472c3a4d3ecf7cb8528a7a3e759815df0 Mon Sep 17 00:00:00 2001 From: Francisco Date: Mon, 25 Mar 2024 16:12:31 +0100 Subject: [PATCH 14/14] Olga approval of the document Co-authored-by: Olga Bulat --- .../proposals/dark_mode/20240313-project_proposal_dark_mode.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md b/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md index 8c10d34aa64..aeece3b81d6 100644 --- a/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md +++ b/documentation/projects/proposals/dark_mode/20240313-project_proposal_dark_mode.md @@ -6,7 +6,7 @@ -- [ ] @obulat +- [x] @obulat - [x] @zackkrida ## Project summary