Add a learn more flyout to the collaborators page #9145

Kapian1234 · 2025-01-06T08:47:35Z

Description

Add a "Learn More" flyout providing additional information to the collaborators page.

Issues Resolved

Screenshot

Testing the changes

Changelog

feat: Add a "Learn More" flyout providing additional information to the collaborators page.

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

Signed-off-by: Kapian1234 <[email protected]>

codecov · 2025-01-06T09:20:11Z

Codecov Report

Attention: Patch coverage is 72.72727% with 3 lines in your changes missing coverage. Please review.

Project coverage is 60.97%. Comparing base (d947bd6) to head (64476fe).
Report is 6 commits behind head on main.

Files with missing lines	Patch %	Lines
...orkspace_collaborators/workspace_collaborators.tsx	40.00%	2 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #9145      +/-   ##
==========================================
- Coverage   60.97%   60.97%   -0.01%     
==========================================
  Files        3812     3813       +1     
  Lines       91353    91369      +16     
  Branches    14433    14436       +3     
==========================================
+ Hits        55703    55711       +8     
- Misses      32096    32101       +5     
- Partials     3554     3557       +3

Flag	Coverage Δ
Linux_1	`29.06% <72.72%> (+<0.01%)`	⬆️
Linux_2	`56.45% <ø> (ø)`
Linux_3	`37.97% <ø> (+<0.01%)`	⬆️
Linux_4	`29.03% <ø> (-0.01%)`	⬇️
Windows_1	`29.07% <72.72%> (+<0.01%)`	⬆️
Windows_2	`56.40% <ø> (ø)`
Windows_3	`37.97% <ø> (+<0.01%)`	⬆️
Windows_4	`29.03% <ø> (-0.01%)`	⬇️

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.

…ch-Dashboards into collaborators_learnMore

Signed-off-by: Kapian1234 <[email protected]>

raintygao · 2025-01-07T07:04:15Z

src/plugins/workspace/public/components/workspace_form/workspace_privacy_flyout.tsx

+  ];
+  return (
+    <EuiFlyout
+      style={{ maxWidth: 431 }}


Is it necessary to hard code max width here?

I found that the maxWidth of use case flyout is 431, so I thought it might be the same for the privacy flyout. We could remove it if it's not necessary.

Flyout has size property, perhaps using s is good enough?

Thanks! size="s" looks better.

Signed-off-by: Kapian1234 <[email protected]>

Hailong-am · 2025-01-09T01:04:06Z

src/plugins/workspace/public/components/workspace_collaborators/workspace_collaborators.tsx

+          {
+            label: i18n.translate('workspace.form.panels.collaborator.learnMore', {
+              defaultMessage: 'Learn more',
+            }),
+            controlType: 'link',
+            run: handleLearnMoreClick,
+          } as TopNavControlLinkData,


Should this be part of description?

Yes. Thank you for the reminder!

Hailong-am · 2025-01-09T01:06:21Z

src/plugins/workspace/public/components/workspace_form/workspace_privacy_flyout.test.tsx

+  it('should render normally', () => {
+    const { renderResult } = setup();
+    expect(renderResult).toMatchSnapshot();


Nit: this is too general

Hailong-am · 2025-01-09T01:11:09Z

src/plugins/workspace/public/components/workspace_form/workspace_privacy_flyout.tsx

+                {description}
+              </EuiText>
+              <EuiSpacer />
+              <EuiLink href={link} target="_blank" style={{ fontWeight: 'normal' }}>


Do we need inline style here?

Yes, otherwise it would be bold, which is not expected.

SuZhou-Joe · 2025-01-09T03:16:36Z

src/core/public/doc_links/doc_links_service.ts

@@ -437,8 +437,10 @@ export class DocLinksService {
            advancedSettings: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}management/advanced-settings/`,
          },
          workspace: {
-            // https://opensearch.org/docs/latest/dashboards/workspace/workspace-acl/
-            acl: `${OPENSEARCH_DASHBOARDS_VERSIONED_DOCS}workspace/workspace-acl/`,


Is it safe to delete this entry?

It was a mistake. It should be removed in this pr but I forgot it. So I remove it here.

Signed-off-by: Kapian1234 <[email protected]>

* Add a learn more flyout to the collaborators page Signed-off-by: Kapian1234 <[email protected]> * Changeset file for PR #9145 created/updated * Update the link Signed-off-by: Kapian1234 <[email protected]> * Update snapshots Signed-off-by: Kapian1234 <[email protected]> * Modify flyout size Signed-off-by: Kapian1234 <[email protected]> * Update collaborators description Signed-off-by: Kapian1234 <[email protected]> * Move learn_more link into the description Signed-off-by: Kapian1234 <[email protected]> --------- Signed-off-by: Kapian1234 <[email protected]> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> (cherry picked from commit e401613) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…#9145) * Add a learn more flyout to the collaborators page Signed-off-by: Kapian1234 <[email protected]> * Changeset file for PR opensearch-project#9145 created/updated * Update the link Signed-off-by: Kapian1234 <[email protected]> * Update snapshots Signed-off-by: Kapian1234 <[email protected]> * Modify flyout size Signed-off-by: Kapian1234 <[email protected]> * Update collaborators description Signed-off-by: Kapian1234 <[email protected]> * Move learn_more link into the description Signed-off-by: Kapian1234 <[email protected]> --------- Signed-off-by: Kapian1234 <[email protected]> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>

Add a learn more flyout to the collaborators page

8a1a48e

Signed-off-by: Kapian1234 <[email protected]>

github-actions bot added the seasoned-contributor label Jan 6, 2025

opensearch-changeset-bot bot and others added 2 commits January 6, 2025 08:48

Changeset file for PR opensearch-project#9145 created/updated

c5d2aeb

Update the link

67471c7

Signed-off-by: Kapian1234 <[email protected]>

Kapian1234 marked this pull request as ready for review January 6, 2025 09:09

Kapian1234 added 2 commits January 7, 2025 10:51

Merge branch 'main' of https://github.com/opensearch-project/OpenSear…

07d5ae3

…ch-Dashboards into collaborators_learnMore

Update snapshots

b19b07f

Signed-off-by: Kapian1234 <[email protected]>

raintygao reviewed Jan 7, 2025

View reviewed changes

wanglam mentioned this pull request Jan 8, 2025

[Workspace] Add privacy levels to the workspace #8907

Merged

7 tasks

Modify flyout size

5d6c0ef

Signed-off-by: Kapian1234 <[email protected]>

ruanyl previously approved these changes Jan 8, 2025

View reviewed changes

ruanyl added the backport 2.x label Jan 8, 2025

Resolve conflicts

a761ef1

Signed-off-by: Kapian1234 <[email protected]>

Kapian1234 dismissed ruanyl’s stale review via a761ef1 January 8, 2025 07:56

Hailong-am reviewed Jan 9, 2025

View reviewed changes

SuZhou-Joe added the workspace label Jan 9, 2025

SuZhou-Joe reviewed Jan 9, 2025

View reviewed changes

Kapian1234 added 2 commits January 9, 2025 11:41

Update collaborators description

0ffa9fc

Signed-off-by: Kapian1234 <[email protected]>

Move learn_more link into the description

64476fe

Signed-off-by: Kapian1234 <[email protected]>

SuZhou-Joe approved these changes Jan 9, 2025

View reviewed changes

Hailong-am approved these changes Jan 10, 2025

View reviewed changes

ruanyl merged commit e401613 into opensearch-project:main Jan 10, 2025
69 checks passed

opensearch-trigger-bot bot mentioned this pull request Jan 10, 2025

[Backport 2.x] Add a learn more flyout to the collaborators page #9168

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a learn more flyout to the collaborators page #9145

Add a learn more flyout to the collaborators page #9145

Kapian1234 commented Jan 6, 2025

codecov bot commented Jan 6, 2025 •

edited

Loading

raintygao Jan 7, 2025

Kapian1234 Jan 7, 2025 •

edited

Loading

ruanyl Jan 8, 2025

Kapian1234 Jan 8, 2025

Hailong-am Jan 9, 2025

Kapian1234 Jan 9, 2025

Hailong-am Jan 9, 2025

Hailong-am Jan 9, 2025

Kapian1234 Jan 9, 2025

SuZhou-Joe Jan 9, 2025

Kapian1234 Jan 9, 2025

Add a learn more flyout to the collaborators page #9145

Add a learn more flyout to the collaborators page #9145

Conversation

Kapian1234 commented Jan 6, 2025

Description

Issues Resolved

Screenshot

Testing the changes

Changelog

Check List

codecov bot commented Jan 6, 2025 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Kapian1234 Jan 7, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Jan 6, 2025 •

edited

Loading

Kapian1234 Jan 7, 2025 •

edited

Loading