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

Unified Dashboard: Register existing widgets in new Content area #4078

Closed
tofumatt opened this issue Sep 20, 2021 · 6 comments
Closed

Unified Dashboard: Register existing widgets in new Content area #4078

tofumatt opened this issue Sep 20, 2021 · 6 comments
Labels
P1 Medium priority QA: Eng Requires specialized QA by an engineer Rollover Issues which role over to the next sprint Type: Enhancement Improvement of an existing feature
Milestone

Comments

@tofumatt
Copy link
Collaborator

tofumatt commented Sep 20, 2021

Feature Description

The widgets that should appear in the Content area (created in #4031):

mainDashboardContentPrimary area:

  1. Top keywords widget (half-width widget) (DashboardPopularKeywordsWidget)
  2. Idea Hub widget (half-width) (DashboardIdeasWidget)
  3. New widget with overall page metrics (new widget, so shouldn't be registered by this issue, instead registered in New Widget: Overall Page Metrics #4122)
  4. Modified most popular content widget (ModulePopularPagesWidget)

entityDashboardContentPrimary area:

  1. Top keywords widget (full width) (DashboardPopularKeywordsWidget)
  2. New widget with overall page metrics (new widget, so shouldn't be registered by this issue*)

Do not alter or remove anything below. The following sections will be managed by moderators only.

Acceptance criteria

These widgets should be registered to the following areas and appear on the Main Dashboard and Entity Dashboard respectively, in this order:

mainDashboardContentPrimary area:

  • Top keywords widget (half-width widget) (DashboardPopularKeywordsWidget)
  • Idea Hub widget (half-width) (DashboardIdeasWidget)
  • Modified most popular content widget (ModulePopularPagesWidget)

entityDashboardContentPrimary area:

  • Top keywords widget (full width) (DashboardPopularKeywordsWidget)

Implementation Brief

Inside assets/js/modules/search-console/index.js:

  • Import AREA_MAIN_DASHBOARD_CONTENT_PRIMARY and AREA_ENTITY_DASHBOARD_CONTENT_PRIMARY from assets/js/googlesitekit/widgets/default-areas.js
  • Inside the call to widgetsAPI.registerWidget for the DashboardPopularKeywordsWidget:
    • Add AREA_MAIN_DASHBOARD_CONTENT_PRIMARY and AREA_ENTITY_DASHBOARD_CONTENT_PRIMARY to the array passed as the last argument.
    • Add WIDGET_WIDTHS.HALF and WIDGET_WIDTHS.FULL to the array passed to options.width (the options object is the second argument)

Inside assets/js/modules/idea-hub/index.js:

  • Import AREA_MAIN_DASHBOARD_CONTENT_PRIMARY from assets/js/googlesitekit/widgets/default-areas.js
  • Inside the call to widgetsAPI.registerWidget for the DashboardIdeasWidget:
    • Add AREA_MAIN_DASHBOARD_CONTENT_PRIMARY to the array passed as the last argument.
    • Add WIDGET_WIDTHS.HALF to the array passed to options.width

Inside assets/js/modules/analytics/index.js:

  • Import AREA_MAIN_DASHBOARD_CONTENT_PRIMARY from assets/js/googlesitekit/widgets/default-areas.js
  • Inside the call to widgetsAPI.registerWidget for the ModulePopularPagesWidget:
    • Add AREA_MAIN_DASHBOARD_CONTENT_PRIMARY to the array passed as the last argument.
    • Add WIDGET_WIDTHS.FULL to the array passed to options.width

Test Coverage

  • No new tests required, existing tests should pass.

QA Brief

  • Check that DashboardPopularKeywordsWidget, DashboardIdeasWidget, and ModulePopularPagesWidget widgets have new areas added.

Changelog entry

  • Add Content Area widgets to Unified Dashboard
@tofumatt tofumatt added P1 Medium priority Type: Enhancement Improvement of an existing feature labels Sep 20, 2021
@tofumatt tofumatt added this to the Sprint 59 milestone Sep 20, 2021
@eugene-manuilov
Copy link
Collaborator

@johnPhillips, sending this ticket back to you to make adjustments discussed in #4079

@eugene-manuilov
Copy link
Collaborator

Thanks, @johnPhillips. IB ✔️

@eugene-manuilov eugene-manuilov removed their assignment Sep 27, 2021
@eugene-manuilov eugene-manuilov added the QA: Eng Requires specialized QA by an engineer label Sep 27, 2021
@tofumatt tofumatt assigned tofumatt and unassigned tofumatt Oct 7, 2021
@fhollis fhollis modified the milestones: Sprint 59, Sprint 60 Oct 11, 2021
@fhollis fhollis added the Rollover Issues which role over to the next sprint label Oct 11, 2021
@kuasha420 kuasha420 self-assigned this Oct 14, 2021
@kuasha420
Copy link
Contributor

QA: ⚠️

I confirmed that.

  • The widgets from the AC has been registered to Main and Entity Dashboard and are showing up.
  • Idea Hub Widget shows the CTA to connect and once connected, shows ideas.

Things I noticed that needs clarification:

  • Padding and margin on half width DashboardPopularKeywordsWidget is off, specially the top padding seems unaligned with the idea hub module.
  • If Analytics module is not connected, the ModulePopularPagesWidget shows loading skeleton forever instead of a CTA to activate analytics module. Not sure if it falls outside of the scope this ticket.

Waiting for clarification.

CC @eugene-manuilov

@eugene-manuilov
Copy link
Collaborator

Thanks, @kuasha420, but this is out-of-scope for this ticket since this ticket is intended to add widgets to new areas only.

Padding and margin on half width DashboardPopularKeywordsWidget is off, specially the top padding seems unaligned with the idea hub module.

I believe this issue will be addressed in a separate ticket.

If Analytics module is not connected, the ModulePopularPagesWidget shows loading skeleton forever instead of a CTA to activate analytics module. Not sure if it falls outside of the scope this ticket.

This one will be fixed with #4226.

@kuasha420
Copy link
Contributor

@eugene-manuilov thanks for clarifying. This it good to go then.

QA - ✔️

@kuasha420 kuasha420 removed their assignment Oct 18, 2021
@felixarntz
Copy link
Member

During approval for this I discovered a problem with this, which is unrelated to the issue here though, more related to #4031. Since it's still behind a feature flag, I opened a new issue #4268 to fix this. cc @tofumatt

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P1 Medium priority QA: Eng Requires specialized QA by an engineer Rollover Issues which role over to the next sprint Type: Enhancement Improvement of an existing feature
Projects
None yet
Development

No branches or pull requests

6 participants