SHS-5913 Dashboard initiative #1689

dalin- · 2024-11-21T20:51:41Z

Summary

A Sandbox with the Dashboard module for further experimentation.

ahughes3 · 2024-12-13T21:05:39Z

@dalin- This PR was helpful! I think we can close it now that we have #1697

dalin- · 2024-12-13T22:05:50Z

@ahughes3
cc @cienvaras
I think we still need a long-running branch to merge all of our dashboard tickets into. We don't want the dashboard to appear on the live site until we've reached a critical mass of approved blocks.

ahughes3 · 2024-12-13T22:21:18Z

I agree with that, thank you!

…-5913_Dashboard-initiative

* feat(shs-5972): use default drupal layouts in dashboard * feat(shs-5972): use DashboardSectionStorage instead * feat(shs-5972): use DashboardSectionStorage instead * fix(shs-5972): small fixes in code * fix(shs-5972): small fixes in code * Update docroot/modules/humsci/hs_layouts/hs_layouts.info.yml Co-authored-by: Andrés Díaz Soto <andres.diaz.soto@gmail.com> --------- Co-authored-by: Mari Nez <mariannuar@gmail.com> Co-authored-by: Andrés Díaz Soto <andres.diaz.soto@gmail.com>

…-5913_Dashboard-initiative

* feat(SHS-5979 and SHS-5982): Add dashboard views and custom view code * chore(SHS-5979 and SHS-5982): Temp add chemistry as a Tugboat site * chore(SHS-5979 and SHS-5982): Temp add chemistry CI settings * feat(SHS-5979): Add pager for duplicate people - possible fix for timeout on Tugboat * feat(SHS-5979 and SHS-5982): Change no results text * chore(shs-5979): add latest edits and duplicate people blocks to test dashboard --------- Co-authored-by: Andrés Díaz Soto <andres.diaz.soto@gmail.com>

) * feat(shs-6004): update pages with the most issues block from editoria11y * chore(shs-6004): add editoria11y block to dashboard * fix(shs-6004): remove duplicated requirement in exported dashboard config --------- Co-authored-by: Mari Nez <mariannuar@gmail.com> Co-authored-by: Andrés Díaz Soto <andres.diaz.soto@gmail.com>

cienvaras · 2025-02-12T19:45:48Z

@joegl We created this branch to add all the dashboard related work. That includes general dashboard configuration and some blocks we want to include in it. We still need to add more blocks and probably some UI/UX improvements and fixes, but I wanted to ask you to take a quick look in case there's any issue that we can start working on before doing the final review. Thanks!

dalin-

We should remember to upgrade to a real release.

dalin- · 2025-02-12T21:10:09Z

composer.json

Now that Dashboard has a real release, we should switch to a stable version.

That's exciting to finally get a stable release. Security Coverage too 😃

* feat(SHS-6055): Add importers block with people importer info table * fix(SHS-6055): Fix typo in dependency * fix(SHS-6055): Change to snake case, fix empty orphan action setting * feat(SHS-6055): Add no results message when no people importers are found * refactor(SHS-6055): Change name of some variables * chore(shs-6055): add importers block to test dashboard * feat(SHS-6055): Add changes from Albert review --------- Co-authored-by: Andrés Díaz Soto <andres.diaz.soto@gmail.com>

…-5913_Dashboard-initiative

* feat(SHS-5979 and SHS-5982): Add dashboard views and custom view code * chore(SHS-5979 and SHS-5982): Temp add chemistry as a Tugboat site * chore(SHS-5979 and SHS-5982): Temp add chemistry CI settings * feat(SHS-5979): Add pager for duplicate people - possible fix for timeout on Tugboat * feat(SHS-5979 and SHS-5982): Change no results text * chore(shs-5979): add latest edits and duplicate people blocks to test dashboard * feat(SHS-5980): Add announcements block * fix(SHS-5980): Fix linting error * fix(shs-5980): remove tugboat chemistry config * fix(SHS-5980): Fix caching and empty CSV rows * fix(SHS-5980): Minor fixes from code review * feat(SHS-5980): Remove title column --------- Co-authored-by: Andrés Díaz Soto <andres.diaz.soto@gmail.com>

ahughes3 · 2025-02-28T17:11:39Z

Tugboat has finished building the preview for this pull request!

Links:

Dashboard:

https://dashboard.tugboatqa.com/6761d081252c7a7b92af8d8f

Visual Diffs:

https://dashboard.tugboatqa.com/6761d081252c7a7b92af8d8f/visualdiffs

joegl · 2025-03-03T20:27:17Z

composer.json

@@ -79,6 +79,7 @@
        "drupal/core-composer-scaffold": "~10.3.0",
        "drupal/core-recommended": "~10.3.0",
        "drupal/cshs": "^4.0",
+        "drupal/dashboard": "^2.0@alpha",


Suggested change

"drupal/dashboard": "^2.0@alpha",

"drupal/dashboard": "^2.0",

joegl · 2025-03-03T20:28:23Z

config/default/dashboard.dashboard.dashboard.yml

+id: dashboard
+label: Dashboard


There may be more dashboards in the future? Calling this "Home Dashboard" or "Main Dashboard" could help future-proof.

joegl · 2025-03-03T20:29:54Z

docroot/modules/humsci/hs_dashboard/hs_dashboard.info.yml

+  - stanford_migrate
+  - hs_capx


Suggested change

- stanford_migrate

- hs_capx

- stanford_migrate

- hs_capx

- dashboard

I'd add the dashboard module as a dependency.

joegl · 2025-03-03T20:32:19Z

docroot/modules/humsci/hs_dashboard/src/AnnouncementsManager.php

+  /**
+   * Announcement CSV location.
+   */
+  const ANNOUNCEMENTS_CSV = 'https://docs.google.com/spreadsheets/d/e/2PACX-1vTQzSuPudq048D1NadRBE9h_s_-w-o4YtcC6AHfCdcqn3gX52akZNOaF5KAG9SeXkCV6PvIVmRtQ0HR/pub?gid=1146337887&single=true&output=csv';


Could this be configurable instead of hard-coded? Doesn't have to be exposed via a form but then it could be changed with a config set and not a code push if ever necessary.

joegl · 2025-03-03T20:34:44Z

docroot/modules/humsci/hs_dashboard/src/AnnouncementsManager.php

+      ];
+    }
+
+    \Drupal::cache()->set('hs_dashboard_csv_announcements', $table_rows, time() + 120);


~2 minutes seems a bit high. Maybe 5-10? I'm not sure what would be optimal here. ~ See other comment on the block about using cachetags and moving the rendering to the block and caching that.

joegl · 2025-03-03T20:35:46Z

docroot/modules/humsci/hs_dashboard/src/Plugin/Block/HsdpAnnouncementsBlock.php

+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Provides a hsdp announcements block.


Suggested change

* Provides a hsdp announcements block.

* Provides an HSDP announcements block.

joegl · 2025-03-03T20:39:49Z

docroot/modules/humsci/hs_dashboard/src/Plugin/Block/HsdpAnnouncementsBlock.php

+  /**
+   * {@inheritdoc}
+   */
+  public function build(): array {


Ideally the table (headers and rows) would be built and cached separately in the build() method here instead of in the service. The cache would use a cacheTag. The service would be isolated to making the necessary API call and returning the data. If the data hasn't changed (which a hash could be used based on the data in the API call) it wouldn't re-render/build the block but return the already rendered table.

joegl · 2025-03-03T20:42:23Z

docroot/modules/humsci/hs_dashboard/src/Plugin/Block/HsImportersInfoBlock.php

+  /**
+   * {@inheritdoc}
+   */
+  public function build(): array {


Same idea as the Announcements block and service here. The table should be rendered and cached in this build method and the service should be used for returning the data.

joegl · 2025-03-03T20:43:45Z

docroot/themes/humsci/su_humsci_gin_admin/dist/su_humsci_dashboard.css

@@ -0,0 +1,179 @@
+/* Dashboard */


I saw this issue in the queue for the dashboard module: https://www.drupal.org/project/dashboard/issues/3490876

Hopefully it will provide better support for the gin admin theme.

feat(SHS-5913): Initial install of Dashboard module

585d2fd

dalin- added the don't merge label Nov 21, 2024

ahughes3 temporarily deployed to Tugboat November 21, 2024 20:51 Destroyed

dalin- requested a review from ahughes3 November 21, 2024 20:51

ahughes3 temporarily deployed to Tugboat November 22, 2024 19:01 Destroyed

ahughes3 temporarily deployed to Tugboat December 4, 2024 04:05 Destroyed

Merge branch 'develop' into SHS-5913_Dashboard-initiative

fe73ee3

ahughes3 temporarily deployed to Tugboat December 4, 2024 04:07 Destroyed

ahughes3 temporarily deployed to Tugboat December 11, 2024 18:01 Destroyed

ahughes3 approved these changes Dec 13, 2024

View reviewed changes

Merge branch '11.6.1-release' of github.com:SU-HSDO/suhumsci into SHS…

1099e87

…-5913_Dashboard-initiative

ahughes3 temporarily deployed to Tugboat December 14, 2024 00:29 Destroyed

cienvaras changed the base branch from develop to 11.6.1-release December 14, 2024 00:29

ahughes3 temporarily deployed to Tugboat December 17, 2024 19:26 Destroyed

ahughes3 temporarily deployed to Tugboat January 6, 2025 17:57 Destroyed

Base automatically changed from 11.6.1-release to develop January 8, 2025 16:39

ahughes3 temporarily deployed to Tugboat January 13, 2025 20:00 Destroyed

cienvaras changed the base branch from develop to 11.6.3-release January 21, 2025 00:26

Base automatically changed from 11.6.3-release to develop January 22, 2025 16:25

Merge branch '11.6.4-release' of github.com:SU-HSDO/suhumsci into SHS…

9c804d8

…-5913_Dashboard-initiative

ahughes3 temporarily deployed to Tugboat January 27, 2025 17:04 Destroyed

cienvaras changed the base branch from develop to 11.6.4-release January 27, 2025 17:04

feat(shs-6052): export base dashboard

3bc566d

ahughes3 temporarily deployed to Tugboat February 3, 2025 15:23 Destroyed

Base automatically changed from 11.6.4-release to develop February 6, 2025 16:51

cienvaras changed the base branch from develop to 11.7.1-release February 10, 2025 21:17

ahughes3 temporarily deployed to Tugboat February 11, 2025 23:30 Destroyed

chore(shs-5913): remove chemistry tugboat config

d494cd2

ahughes3 temporarily deployed to Tugboat February 11, 2025 23:52 Destroyed

ahughes3 temporarily deployed to Tugboat February 12, 2025 00:11 Destroyed

fix(shs-5913): update dashboard exported config

a1a9165

ahughes3 temporarily deployed to Tugboat February 12, 2025 00:23 Destroyed

dalin- commented Feb 12, 2025

View reviewed changes

ahughes3 temporarily deployed to Tugboat February 20, 2025 16:45 Destroyed

Base automatically changed from 11.7.1-release to develop February 20, 2025 17:59

cienvaras changed the base branch from develop to 11.8.1-release February 21, 2025 23:14

Merge branch '11.8.1-release' of github.com:SU-HSDO/suhumsci into SHS…

447ce67

…-5913_Dashboard-initiative

ahughes3 temporarily deployed to Tugboat February 21, 2025 23:15 Destroyed

Merge branch '11.8.1-release' of github.com:SU-HSDO/suhumsci into SHS…

c06e05b

…-5913_Dashboard-initiative

ahughes3 temporarily deployed to Tugboat February 25, 2025 20:59 Destroyed

ahughes3 deployed to Tugboat February 28, 2025 17:04 View deployment

joegl reviewed Mar 3, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SHS-5913 Dashboard initiative #1689

SHS-5913 Dashboard initiative #1689

dalin- commented Nov 21, 2024

ahughes3 commented Dec 13, 2024

dalin- commented Dec 13, 2024

ahughes3 commented Dec 13, 2024

cienvaras commented Feb 12, 2025

dalin- left a comment

dalin- Feb 12, 2025

joegl Mar 3, 2025 •

edited

Loading

ahughes3 commented Feb 28, 2025

joegl Mar 3, 2025

joegl Mar 3, 2025

joegl Mar 3, 2025

joegl Mar 3, 2025

joegl Mar 3, 2025 •

edited

Loading

joegl Mar 3, 2025

joegl Mar 3, 2025

joegl Mar 3, 2025

joegl Mar 3, 2025

	"drupal/dashboard": "^2.0@alpha",
	"drupal/dashboard": "^2.0",

	* Provides a hsdp announcements block.
	* Provides an HSDP announcements block.

		id: dashboard
		label: Dashboard

SHS-5913 Dashboard initiative #1689

Are you sure you want to change the base?

SHS-5913 Dashboard initiative #1689

Conversation

dalin- commented Nov 21, 2024

Summary

ahughes3 commented Dec 13, 2024

dalin- commented Dec 13, 2024

ahughes3 commented Dec 13, 2024

cienvaras commented Feb 12, 2025

dalin- left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joegl Mar 3, 2025 • edited Loading

Choose a reason for hiding this comment

ahughes3 commented Feb 28, 2025

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

joegl Mar 3, 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

joegl Mar 3, 2025 •

edited

Loading

joegl Mar 3, 2025 •

edited

Loading