Feat (Advanced Settings): Make new "Appearance" category #4845

joshuarrrr · 2023-08-28T22:25:59Z

Description

And remove "Accessibility".
Give category panels IDs so they can be deep linked

Copy and other settings updates will follow in separate PRs.

Issues Resolved

Partial implementation of #4330
Unblocks #4676

Screenshot

Note that advanced settings are automatically ordered alphabetically by the setting name.

Screen.Recording.2023-08-28.at.3.20.10.PM.mov

Testing the changes

Check List

And remove "Accessibility". Give category panels IDs so they can be deep linked Signed-off-by: Josh Romero <rmerqg@amazon.com>

codecov · 2023-08-28T22:43:17Z

Codecov Report

Merging #4845 (9957efa) into main (ce2d79e) will decrease coverage by 0.01%.
Report is 4 commits behind head on main.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #4845      +/-   ##
==========================================
- Coverage   66.39%   66.39%   -0.01%     
==========================================
  Files        3396     3397       +1     
  Lines       64801    64804       +3     
  Branches    10359    10360       +1     
==========================================
+ Hits        43025    43026       +1     
- Misses      19217    19218       +1     
- Partials     2559     2560       +1

Flag	Coverage Δ
Linux_1	`34.85% <ø> (ø)`
Linux_2	`55.15% <ø> (ø)`
Linux_3	`44.23% <ø> (-0.01%)`	⬇️
Linux_4	`34.92% <ø> (ø)`
Windows_1	`34.87% <ø> (ø)`
Windows_2	`55.12% <ø> (ø)`
Windows_3	`44.24% <ø> (+<0.01%)`	⬆️
Windows_4	`34.92% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed	Coverage Δ
.../core/server/ui_settings/settings/accessibility.ts	`100.00% <ø> (ø)`
src/core/server/ui_settings/settings/navigation.ts	`100.00% <ø> (ø)`
src/core/server/ui_settings/settings/theme.ts	`100.00% <ø> (ø)`
...ngs/public/management_app/components/form/form.tsx	`69.69% <ø> (ø)`
...ngs/public/management_app/lib/get_category_name.ts	`66.66% <ø> (ø)`

... and 3 files with indirect coverage changes

joshuarrrr · 2023-08-28T23:37:56Z

@KrooshalUX This is ready for your review. Note that it's not everything from #4330, but it does have everything moved to the new section, which is deep linkable. Given this minimal implementation, should I go ahead and also update the copy to match the mock (except for the browser settings, which won't be supported in 2.10).

@mnkugler The issue mentions that we want the theme description text to link to a forum post. Can you provide that forum post URL?

KrooshalUX · 2023-08-28T23:41:56Z

👍 this is great incremental progress towards the north star of appearance within advanced settings (#4330 )!

kavilla · 2023-08-29T02:56:46Z

Not sure if this a current issue but will we move forward with the other plugins to add to this category?

Signed-off-by: Josh Romero <rmerqg@amazon.com>

ashwin-pc · 2023-08-29T23:53:35Z

@joshuarrrr Some of the unit tests are failing here, can you look at them?

add link to forum Signed-off-by: Josh Romero <rmerqg@amazon.com>

Signed-off-by: Josh Romero <rmerqg@amazon.com>

joshuarrrr · 2023-08-30T19:19:12Z

Not sure if this a current issue but will we move forward with the other plugins to add to this category?

Are you asking whether plugins can add additional settings to this Appearance category? If so, the answer is yes, which is consistent with how the other categories work.

src/core/server/ui_settings/settings/theme.ts

joshuarrrr · 2023-08-30T19:28:32Z

src/core/server/ui_settings/settings/theme.ts

@@ -53,9 +54,11 @@ export const getThemeSettings = (): Record<string, UiSettingsParams> => {
      type: 'select',
      options: ['v7', 'Next (preview)'],
      description: i18n.translate('core.ui_settings.params.themeVersionText', {
-        defaultMessage: `Switch between the theme used for the current and next version of OpenSearch Dashboards, A page refresh is required for the setting to be applied.`,
+        defaultMessage: `<p>Switch between the theme used for the current and next version of OpenSearch Dashboards. A page refresh is required for the setting to be applied.</p><p><a href="{href}">{linkText}</a></p>`,
+        values: { href: 'https://forum.opensearch.org/', linkText: 'Theme feedback' },


TODO: update href with specific forum post.

I thought I could use the linkService here, but it's a case where we can't really; these settings are defined in /core/server and the linkService is in /core/public.

href updated

src/core/server/ui_settings/settings/theme.ts

Signed-off-by: Josh Romero <rmerqg@amazon.com>

Co-authored-by: Miki <amoo_miki@yahoo.com> Signed-off-by: Josh Romero <rmerqg@amazon.com>

* Feat (Advanced Settings): Make new "Appearance" category And remove "Accessibility". Give category panels IDs so they can be deep linked Signed-off-by: Josh Romero <rmerqg@amazon.com> * updated changelog Signed-off-by: Josh Romero <rmerqg@amazon.com> * Update theme description add link to forum Signed-off-by: Josh Romero <rmerqg@amazon.com> * Update snapshots Signed-off-by: Josh Romero <rmerqg@amazon.com> * update forum link Signed-off-by: Josh Romero <rmerqg@amazon.com> * Update src/core/server/ui_settings/settings/theme.ts Co-authored-by: Miki <amoo_miki@yahoo.com> Signed-off-by: Josh Romero <rmerqg@amazon.com> --------- Signed-off-by: Josh Romero <rmerqg@amazon.com> Co-authored-by: Miki <miki@amazon.com> Co-authored-by: Miki <amoo_miki@yahoo.com> (cherry picked from commit 3e1ef80) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md

* Feat (Advanced Settings): Make new "Appearance" category And remove "Accessibility". Give category panels IDs so they can be deep linked Signed-off-by: Josh Romero <rmerqg@amazon.com> * updated changelog Signed-off-by: Josh Romero <rmerqg@amazon.com> * Update theme description add link to forum Signed-off-by: Josh Romero <rmerqg@amazon.com> * Update snapshots Signed-off-by: Josh Romero <rmerqg@amazon.com> * update forum link Signed-off-by: Josh Romero <rmerqg@amazon.com> * Update src/core/server/ui_settings/settings/theme.ts Co-authored-by: Miki <amoo_miki@yahoo.com> Signed-off-by: Josh Romero <rmerqg@amazon.com> --------- Signed-off-by: Josh Romero <rmerqg@amazon.com> Co-authored-by: Miki <miki@amazon.com> Co-authored-by: Miki <amoo_miki@yahoo.com> (cherry picked from commit 3e1ef80) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Feat (Advanced Settings): Make new "Appearance" category

d4f7c81

And remove "Accessibility". Give category panels IDs so they can be deep linked Signed-off-by: Josh Romero <rmerqg@amazon.com>

joshuarrrr requested review from ananzh, kavilla, seanneumann, AMoo-Miki, ashwin-pc, abbyhu2000, zengyan-amazon, kristenTian, zhongnansu, manasvinibs, ZilongX, Flyingliuhub, BSFishy and curq as code owners August 28, 2023 22:26

github-actions bot added the distinguished-contributor label Aug 28, 2023

updated changelog

0852294

Signed-off-by: Josh Romero <rmerqg@amazon.com>

joshuarrrr added v2.10.0 backport 2.x labels Aug 29, 2023

joshuarrrr mentioned this pull request Aug 29, 2023

[Next theme] Add modal to notify users of theme updates #4715

Merged

8 tasks

joshuarrrr added 3 commits August 30, 2023 16:23

Update theme description

3363313

add link to forum Signed-off-by: Josh Romero <rmerqg@amazon.com>

Update snapshots

f576861

Signed-off-by: Josh Romero <rmerqg@amazon.com>

Merge branch 'main' into feat/advanced-settings-theming

79f1d9c

Signed-off-by: Josh Romero <rmerqg@amazon.com>

AMoo-Miki reviewed Aug 30, 2023

View reviewed changes

src/core/server/ui_settings/settings/theme.ts Outdated Show resolved Hide resolved

AMoo-Miki previously approved these changes Aug 30, 2023

View reviewed changes

ashwin-pc previously approved these changes Aug 31, 2023

View reviewed changes

joshuarrrr commented Aug 31, 2023

View reviewed changes

update forum link

7a835a9

Signed-off-by: Josh Romero <rmerqg@amazon.com>

joshuarrrr dismissed stale reviews from ashwin-pc and AMoo-Miki via 7a835a9 August 31, 2023 17:27

Merge branch 'main' into feat/advanced-settings-theming

d1b3497

ashwin-pc previously approved these changes Aug 31, 2023

View reviewed changes

Update src/core/server/ui_settings/settings/theme.ts

9957efa

Co-authored-by: Miki <amoo_miki@yahoo.com> Signed-off-by: Josh Romero <rmerqg@amazon.com>

joshuarrrr dismissed ashwin-pc’s stale review via 9957efa September 1, 2023 15:27

kavilla approved these changes Sep 1, 2023

View reviewed changes

ashwin-pc approved these changes Sep 1, 2023

View reviewed changes

joshuarrrr merged commit 3e1ef80 into opensearch-project:main Sep 1, 2023
54 checks passed

joshuarrrr deleted the feat/advanced-settings-theming branch September 1, 2023 21:30

opensearch-trigger-bot bot mentioned this pull request Sep 1, 2023

[Backport 2.x] Feat (Advanced Settings): Make new "Appearance" category #4902

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat (Advanced Settings): Make new "Appearance" category #4845

Feat (Advanced Settings): Make new "Appearance" category #4845

joshuarrrr commented Aug 28, 2023 •

edited

Loading

codecov bot commented Aug 28, 2023 •

edited

Loading

joshuarrrr commented Aug 28, 2023

KrooshalUX commented Aug 28, 2023

kavilla commented Aug 29, 2023

ashwin-pc commented Aug 29, 2023

joshuarrrr commented Aug 30, 2023

joshuarrrr Aug 30, 2023

joshuarrrr Aug 31, 2023

Feat (Advanced Settings): Make new "Appearance" category #4845

Feat (Advanced Settings): Make new "Appearance" category #4845

Conversation

joshuarrrr commented Aug 28, 2023 • edited Loading

Description

Issues Resolved

Screenshot

Testing the changes

Check List

codecov bot commented Aug 28, 2023 • edited Loading

Codecov Report

joshuarrrr commented Aug 28, 2023

KrooshalUX commented Aug 28, 2023

kavilla commented Aug 29, 2023

ashwin-pc commented Aug 29, 2023

joshuarrrr commented Aug 30, 2023

joshuarrrr Aug 30, 2023

Choose a reason for hiding this comment

joshuarrrr Aug 31, 2023

Choose a reason for hiding this comment

joshuarrrr commented Aug 28, 2023 •

edited

Loading

codecov bot commented Aug 28, 2023 •

edited

Loading