New Home Page #6065

abbyhu2000 · 2024-03-07T19:42:43Z

Description

This PR is built upon the original home page PR: #5613 authored by @BSFishy

Added a new commit on replacing the yml config with advanced setting.

Issues Resolved

resolves #6056

Screenshot

Testing the changes

Check List

All tests pass
- yarn test:jest
- yarn test:jest_integration
New functionality includes testing.
New functionality has been documented.
Update CHANGELOG.md
Commits are signed per the DCO using --signoff

abbyhu2000 · 2024-03-07T19:43:41Z

Currently i placed the advanced setting under general section. Do we need to change any wording here? @kgcreative @ashwin-pc

ashwin-pc · 2024-03-07T19:57:35Z

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

Cant we add this setting to a new section in the home plugin? Similar to how discover does it? https://github.com/suzhou-joe/opensearch-dashboards/blob/b2f79ca6dfce478be51e5bd394d1676bd75e46ca/src/plugins/discover/server/ui_settings.ts#L58

yes, i just moved the location of the uisettings within the home plugin.

codecov · 2024-03-07T19:58:48Z

Codecov Report

Attention: Patch coverage is 59.82906% with 47 lines in your changes are missing coverage. Please review.

Project coverage is 67.21%. Comparing base (8c4f49a) to head (f2f1146).
Report is 1 commits behind head on main.

Files	Patch %	Lines
.../home/public/services/section_type/section_type.ts	70.00%	12 Missing and 3 partials ⚠️
...on/components/homepage/sections/work_with_data.tsx	25.00%	9 Missing ⚠️
...tion/components/homepage/sections/learn_basics.tsx	30.00%	7 Missing ⚠️
src/plugins/home/public/plugin.ts	50.00%	4 Missing ⚠️
.../public/services/section_type/section_type.mock.ts	63.63%	4 Missing ⚠️
src/plugins/home/server/saved_objects/homepage.ts	25.00%	3 Missing ⚠️
...application/components/homepage/sections/utils.tsx	33.33%	2 Missing ⚠️
...ved_objects_management/public/register_services.ts	0.00%	1 Missing and 1 partial ⚠️
...gins/home/public/saved_homepage/_saved_homepage.ts	87.50%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6065      +/-   ##
==========================================
- Coverage   67.22%   67.21%   -0.01%     
==========================================
  Files        3333     3342       +9     
  Lines       64565    64681     +116     
  Branches    10391    10408      +17     
==========================================
+ Hits        43404    43476      +72     
- Misses      18628    18662      +34     
- Partials     2533     2543      +10

Flag	Coverage Δ
Linux_1	`31.64% <8.24%> (-0.06%)`	⬇️
Linux_2	`55.45% <ø> (ø)`
Linux_3	`44.55% <8.51%> (-0.11%)`	⬇️
Linux_4	`35.09% <59.82%> (+0.10%)`	⬆️
Windows_1	`31.67% <8.24%> (-0.06%)`	⬇️
Windows_2	`55.41% <ø> (ø)`
Windows_3	`44.57% <8.51%> (-0.11%)`	⬇️
Windows_4	`35.09% <59.82%> (+0.10%)`	⬆️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

AMoo-Miki · 2024-03-13T23:18:17Z

.github/workflows/cypress_workflow.yml

@@ -28,7 +28,7 @@ on:

 env:
  TEST_REPO: ${{ inputs.test_repo != '' && inputs.test_repo || 'opensearch-project/opensearch-dashboards-functional-test' }}
-  TEST_BRANCH: "${{ inputs.test_branch != '' && inputs.test_branch || github.base_ref }}"
+  TEST_BRANCH: "${{ 'feature/new-home' || inputs.test_branch != '' && inputs.test_branch || github.base_ref }}"


Do we need this?

changed back

AMoo-Miki · 2024-03-13T23:26:31Z

I would recommend using the changelog from main and adding the entry. The one here has too many changes and almost all are undesired.

ashwin-pc

LGTM except for Miki's suggestion and the changelog conflict. Will approve once thats in.

kgcreative · 2024-03-14T03:49:35Z

Cc: @lauralexis

Signed-off-by: Matt Provost <provomat@amazon.com> Add some things I for some reason didn't get in the initial commit Signed-off-by: Matt Provost <provomat@amazon.com> Add formatting line Signed-off-by: Matt Provost <provomat@amazon.com> Add doc comment explaining get homepage function Signed-off-by: Matt Provost <provomat@amazon.com> Remove unused function Signed-off-by: Matt Provost <provomat@amazon.com> Rename functions to more accurately describe what they do Signed-off-by: Matt Provost <provomat@amazon.com> WE HAVE RENDERING Signed-off-by: Matt Provost <provomat@amazon.com> Make some fixed/clarifications around the lazy rendering Signed-off-by: Matt Provost <provomat@amazon.com> Add basic layout for hero sections and sections Signed-off-by: Matt Provost <provomat@amazon.com> Set up proper section rendering Signed-off-by: Matt Provost <provomat@amazon.com> Add page layout Signed-off-by: Matt Provost <provomat@amazon.com> Add homepage saved object edit button Signed-off-by: Matt Provost <provomat@amazon.com> Memoize section content Signed-off-by: Matt Provost <provomat@amazon.com> Add data section Signed-off-by: Matt Provost <provomat@amazon.com> Add learn basics section Signed-off-by: Matt Provost <provomat@amazon.com> Small cleanup things Signed-off-by: Matt Provost <provomat@amazon.com> Misc changes Signed-off-by: Matt Provost <provomat@amazon.com> Remove custom card display Signed-off-by: Matt Provost <provomat@amazon.com> Fix breadcrumbs not updating Signed-off-by: Matt Provost <provomat@amazon.com> Add small todo comment Signed-off-by: Matt Provost <provomat@amazon.com> Inline section rendering Signed-off-by: Matt Provost <provomat@amazon.com> Fix section type service mock Signed-off-by: Matt Provost <provomat@amazon.com> Fix jest tests Signed-off-by: Matt Provost <provomat@amazon.com> Fix the test mocks Signed-off-by: Matt Provost <provomat@amazon.com> Add throw tests Signed-off-by: Matt Provost <provomat@amazon.com> Remove default hero section Signed-off-by: Matt Provost <provomat@amazon.com> Add a few more tests Signed-off-by: Matt Provost <provomat@amazon.com> Add footer Signed-off-by: Matt Provost <provomat@amazon.com> Fix some of the testing Signed-off-by: Matt Provost <provomat@amazon.com> Add homepage saved object test Signed-off-by: Matt Provost <provomat@amazon.com> Add basic getHomepage test Signed-off-by: Matt Provost <provomat@amazon.com> Remove copilot comments Signed-off-by: Matt Provost <provomat@amazon.com> Add some more tests to ensure functionality is as intended Signed-off-by: Matt Provost <provomat@amazon.com> Remove unused file Signed-off-by: Matt Provost <provomat@amazon.com> Add test subjects Signed-off-by: Matt Provost <provomat@amazon.com> Update changelog Signed-off-by: Matt Provost <provomat@amazon.com> Update with guidance from UX Signed-off-by: Matt Provost <provomat@amazon.com> Convert homepage to use observables Signed-off-by: Matt Provost <provomat@amazon.com> Add doc comment Signed-off-by: Matt Provost <provomat@amazon.com> Finish functionality for observable based homepage Signed-off-by: Matt Provost <provomat@amazon.com> Rename heros to heroes Signed-off-by: Matt Provost <provomat@amazon.com> Update footer i18n ids Signed-off-by: Matt Provost <provomat@amazon.com> Extract layout into its own component Signed-off-by: Matt Provost <provomat@amazon.com> Make the new home experience configurable Signed-off-by: Matt Provost <provomat@amazon.com> Move all legacy home stuff into legacy folder Signed-off-by: Matt Provost <provomat@amazon.com> Update loading and error designs Signed-off-by: Matt Provost <provomat@amazon.com> Change from Webpack import to file path Signed-off-by: Matt Provost <provomat@amazon.com> Add config value for disabling new homepage Signed-off-by: Matt Provost <provomat@amazon.com> Reverse list Signed-off-by: Matt Provost <provomat@amazon.com> Redo some of the comments Signed-off-by: Matt Provost <provomat@amazon.com> Remove old todo comment Signed-off-by: Matt Provost <provomat@amazon.com> Add welcome screen & branding & fix tests Signed-off-by: Matt Provost <provomat@amazon.com> Make new homepage disabled by default Signed-off-by: Matt Provost <provomat@amazon.com> Change disable homepage behavior Signed-off-by: Matt Provost <provomat@amazon.com> Change some names around Signed-off-by: Matt Provost <provomat@amazon.com> Add back recently accessed Signed-off-by: Matt Provost <provomat@amazon.com> Reduce weight of ingestion image Signed-off-by: Matt Provost <provomat@amazon.com> Minor comment addressing Signed-off-by: Matt Provost <provomat@amazon.com> Update learn section with UX feedback Signed-off-by: Matt Provost <provomat@amazon.com> Small redesign cleanup Signed-off-by: Matt Provost <provomat@amazon.com> Fix useShowWelcome semantics Signed-off-by: Matt Provost <provomat@amazon.com> Actually fix show welcome this time Signed-off-by: Matt Provost <provomat@amazon.com> Rename config option Signed-off-by: Matt Provost <provomat@amazon.com>

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> delete workflow change Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

abbyhu2000 · 2024-03-14T19:21:18Z

Should add some fallback mechanism if getting the new home page failed. #6146

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

ananzh · 2024-03-15T23:18:27Z

Thanks for the great work @BSFishy @abbyhu2000

This pull request introduces a comprehensive update to the homepage, focusing on enhancing its layout, functionality, and configurability. Key changes include: * Initial implementation and iterative improvements of the new homepage layout, including the addition of hero sections and various other sections for improved content organization and presentation. * Introduction of lazy rendering and memoization to optimize performance and user experience. * Refinements in section rendering, including inline rendering, to streamline the page's structure and interactivity. * Removal of unused functions and components, alongside renaming functions for better clarity and alignment with their purpose. * Significant enhancements in testing, ensuring robust functionality through the addition of various unit tests, including jest tests and tests for new observable-based features. * Adjustments and updates following UX guidance, including changes to the footer, welcome screen, and other user interface elements to align with best practices and user expectations. * Conversion of the homepage to use observables for dynamic content updates, and making the new homepage experience configurable, allowing for easy toggling between legacy and new layouts. * Comprehensive cleanup and minor redesign efforts to refine the overall look and feel, alongside the removal of outdated comments and redundant code. * Introduction of a new configuration option to enable/disable the new homepage, providing flexibility and control to users or administrators. * Additional contributions include replacing a YAML config with an advanced setting and fixing the changelog for accurate documentation. --------- Signed-off-by: Matt Provost <provomat@amazon.com> Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> Co-authored-by: Matt Provost <provomat@amazon.com> Co-authored-by: Ashwin P Chandran <ashwinpc@amazon.com> (cherry picked from commit d1dd85b) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md

This pull request introduces a comprehensive update to the homepage, focusing on enhancing its layout, functionality, and configurability. Key changes include: * Initial implementation and iterative improvements of the new homepage layout, including the addition of hero sections and various other sections for improved content organization and presentation. * Introduction of lazy rendering and memoization to optimize performance and user experience. * Refinements in section rendering, including inline rendering, to streamline the page's structure and interactivity. * Removal of unused functions and components, alongside renaming functions for better clarity and alignment with their purpose. * Significant enhancements in testing, ensuring robust functionality through the addition of various unit tests, including jest tests and tests for new observable-based features. * Adjustments and updates following UX guidance, including changes to the footer, welcome screen, and other user interface elements to align with best practices and user expectations. * Conversion of the homepage to use observables for dynamic content updates, and making the new homepage experience configurable, allowing for easy toggling between legacy and new layouts. * Comprehensive cleanup and minor redesign efforts to refine the overall look and feel, alongside the removal of outdated comments and redundant code. * Introduction of a new configuration option to enable/disable the new homepage, providing flexibility and control to users or administrators. * Additional contributions include replacing a YAML config with an advanced setting and fixing the changelog for accurate documentation. --------- Signed-off-by: Matt Provost <provomat@amazon.com> Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> Co-authored-by: Matt Provost <provomat@amazon.com> Co-authored-by: Ashwin P Chandran <ashwinpc@amazon.com> (cherry picked from commit d1dd85b) 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>

abbyhu2000 marked this pull request as ready for review March 7, 2024 19:42

abbyhu2000 requested review from ananzh and kavilla as code owners March 7, 2024 19:43

github-actions bot added the distinguished-contributor label Mar 7, 2024

abbyhu2000 requested review from AMoo-Miki, ashwin-pc, joshuarrrr, zengyan-amazon, kristenTian, zhongnansu, manasvinibs, ZilongX, Flyingliuhub, BSFishy, curq, bandinib-amzn, SuZhou-Joe, ruanyl and BionIT as code owners March 7, 2024 19:43

ashwin-pc reviewed Mar 7, 2024

View reviewed changes

ashwin-pc self-assigned this Mar 8, 2024

AMoo-Miki reviewed Mar 13, 2024

View reviewed changes

ashwin-pc reviewed Mar 14, 2024

View reviewed changes

abbyhu2000 force-pushed the replace_toggle_with_advanced_setting branch 3 times, most recently from 532a468 to 99b7f29 Compare March 14, 2024 19:01

abbyhu2000 force-pushed the replace_toggle_with_advanced_setting branch from 99b7f29 to 999f873 Compare March 14, 2024 19:02

BSFishy and others added 2 commits March 14, 2024 19:11

Replace yml config with advanced setting

e370393

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com> delete workflow change Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

abbyhu2000 force-pushed the replace_toggle_with_advanced_setting branch from 999f873 to df345e1 Compare March 14, 2024 19:12

fix changelog

d83f5a2

Signed-off-by: abbyhu2000 <abigailhu2000@gmail.com>

abbyhu2000 force-pushed the replace_toggle_with_advanced_setting branch from df345e1 to d83f5a2 Compare March 14, 2024 19:17

kavilla added the v2.13.0 label Mar 15, 2024

kavilla assigned AMoo-Miki Mar 15, 2024

Merge branch 'main' into replace_toggle_with_advanced_setting

f2f1146

Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>

ashwin-pc approved these changes Mar 15, 2024

View reviewed changes

ananzh approved these changes Mar 15, 2024

View reviewed changes

ananzh added the backport 2.x label Mar 15, 2024

ananzh merged commit d1dd85b into opensearch-project:main Mar 15, 2024
70 of 71 checks passed

opensearch-trigger-bot bot mentioned this pull request Mar 15, 2024

[Backport 2.x] New Home Page #6169

Merged

This was referenced Mar 18, 2024

[Look and Feel] New Home Page Experience #4966

Closed

[RFC] New Homepage Technical Design #5251

Closed

New homepage #5613

Closed

ananzh mentioned this pull request Jun 18, 2024

[BUG] homepage doc migration issue #7024

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New Home Page #6065

New Home Page #6065

abbyhu2000 commented Mar 7, 2024

abbyhu2000 commented Mar 7, 2024

ashwin-pc Mar 7, 2024

abbyhu2000 Mar 7, 2024

codecov bot commented Mar 7, 2024 •

edited

Loading

AMoo-Miki Mar 13, 2024

ashwin-pc Mar 14, 2024

abbyhu2000 Mar 14, 2024

AMoo-Miki commented Mar 13, 2024

ashwin-pc left a comment

kgcreative commented Mar 14, 2024

abbyhu2000 commented Mar 14, 2024

ananzh commented Mar 15, 2024

New Home Page #6065

New Home Page #6065

Conversation

abbyhu2000 commented Mar 7, 2024

Description

Issues Resolved

Screenshot

Testing the changes

Check List

abbyhu2000 commented Mar 7, 2024

ashwin-pc Mar 7, 2024

Choose a reason for hiding this comment

abbyhu2000 Mar 7, 2024

Choose a reason for hiding this comment

codecov bot commented Mar 7, 2024 • edited Loading

Codecov Report

AMoo-Miki Mar 13, 2024

Choose a reason for hiding this comment

ashwin-pc Mar 14, 2024

Choose a reason for hiding this comment

abbyhu2000 Mar 14, 2024

Choose a reason for hiding this comment

AMoo-Miki commented Mar 13, 2024

ashwin-pc left a comment

Choose a reason for hiding this comment

kgcreative commented Mar 14, 2024

abbyhu2000 commented Mar 14, 2024

ananzh commented Mar 15, 2024

codecov bot commented Mar 7, 2024 •

edited

Loading