Add thumbnail for featured dataverses #10433

jeromeroucou · 2024-03-27T11:01:41Z

What this PR does / why we need it:

With this PR, a dataverse administrator can set a thumbnail image into theme page, to be displayed in featured dataverses. Unlike logo or footer images, the preview image has no display parameters such as "logo format" or "logo alignment".

The following rule applies to the images displayed for featured collections: if a preview image is present then it's displayed, else if a banner is present then it's displayed, else the default Dataverse logo is displayed.

Which issue(s) this PR closes:

Closes Dataverse collection thumbnail in addition to Logo Image as banner #10291

Special notes for your reviewer:

I have to refactor some code to fix a bug : I move image suppression block instruction from UpdateDataverseThemeCommand.java to ThemeWidgetFragment.java. When the logo was first deleted, the theme was saved in database with partial information (no footer). When the image footer was deleted, as the database theme no longer contained this information, so the image was not deleted.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

dataverse_thumbnail_featured_dataverses.webm

Additional documentation:

Dataverse management documentation page have been modify to add the feature

Preview docs at https://dataverse-guide--10433.org.readthedocs.build/en/10433/user/dataverse-management.html#theme

coveralls · 2024-03-27T11:11:49Z

coverage: 20.754% (-0.005%) from 20.759%
when pulling 27f682f on Recherche-Data-Gouv:10291-collection_thumbnail
into d4b9260 on IQSS:develop.

pdurbin

Interesting feature! I left some quick feedback. Thanks for the video!

pdurbin · 2024-03-27T11:19:59Z

doc/sphinx-guides/source/user/dataverse-management.rst

@@ -69,7 +69,8 @@ The Theme features provides you with a way to customize the look of your Dataver

 - Inherit the theme from the parent Dataverse collection. This option is helpful if you'd like consistency across several Dataverse collections that all share the same parent.
 - Add or update a logo image, which will appear at the top of your Dataverse collection.
- Add or update a footer image, which will appear at at the bottom of your Dataverse collection.
+- Add or update a thumbnail image, which will appear on featured dataverses of your Dataverse collection.


Interesting feature! My first thought is, should this feature be available via API? That way the new frontend can use it some day.

Also, these issue are related:

Feature Request/Idea: Native API access to upload collection logos and Theme specifications #10194

Feature Request/Idea: Set featured collections through Native API #10242

In order to have thumbnail logo via API, all Theme feature have to be moved before. Do you know if the development of #10194 is well advanced and PR will be open soon ?

Either I wait for PR #10194 to be accepted (and I adapt the source code from it), or I propose one. But either way, I should change the status of this PR (#10433) to draft.

I got the impression from @DS-INRA that he might have a team member like you work on #10194 but maybe I'm wrong! 😅

doc/sphinx-guides/source/user/dataverse-management.rst

pdurbin · 2024-03-27T11:21:14Z

src/main/resources/db/migration/V6.1.0.6__10291-collection-thumbnail.sql

Please be aware that we are changing how we name these flyway files:

Update Flyway docs to shorten SQL script filenames to prevent conflicts #10380

Oh, I hadn't realized this change, thanks for the information !

pdurbin

Just a suggestion for the release note.

doc/release-notes/10433-release-notes.md

cmbz · 2024-03-28T18:52:30Z

2024/03/28

Prioritized due to relationship with already prioritized issue that is currently waiting: Feature Request/Idea: Native API access to upload collection logos and Theme specifications #10194

Co-authored-by: Philip Durbin <philipdurbin@gmail.com>

Add new recommandations (HTML preview + "for more information ...")

pdurbin · 2024-08-05T19:49:59Z

@jeromeroucou this PR has merge conflicts. Can you please resolve them?

DS-INRA · 2024-08-07T13:30:35Z

Hi @pdurbin , @jeromeroucou is currently on vacation and will be able to get back to this PR in september :)

pdurbin · 2024-08-27T18:22:40Z

Maybe @luddaniel can fix the merge conflicts? They seem pretty straightforward but I can't push to https://github.com/Recherche-Data-Gouv/dataverse

It should be just a matter of renaming the sql file (bumping the version to the next available):

pdurbin@beamish dataverse % git merge develop
Auto-merging src/main/java/edu/harvard/iq/dataverse/DataverseServiceBean.java
Auto-merging src/main/java/propertyFiles/Bundle.properties
Auto-merging src/main/resources/db/migration/V6.2.0.1.sql
CONFLICT (add/add): Merge conflict in src/main/resources/db/migration/V6.2.0.1.sql
Automatic merge failed; fix conflicts and then commit the result.
pdurbin@beamish dataverse %

Heads up that there's also a sql file in #10694 so one of these PRs will need to bump again. Here are our docs on the matter, if you haven't seen them: https://guides.dataverse.org/en/6.3/developers/sql-upgrade-scripts.html

luddaniel · 2024-08-28T09:03:10Z

@pdurbin done ;) we will rename sql file once again if needed.

By the way, RemoteOverlayAccessIOTest.testRemoteOverlayFiles:103 expected: <true> but was: <false> is also failing on develop

pdurbin

I had a quick play with this and it seems to work. The code seems fine, I think. Approved.

pdurbin · 2024-09-04T15:49:37Z

Screenshots from playing around with this feature:

jeromeroucou added 2 commits March 21, 2024 10:48

Add thumbnail for futured dataverses

124943f

Add documentation

0041d45

pdurbin reviewed Mar 27, 2024

View reviewed changes

jeromeroucou added 2 commits March 27, 2024 16:21

Release note snippet

45aa438

New flyway namming

34fdade

pdurbin reviewed Mar 27, 2024

View reviewed changes

doc/release-notes/10433-release-notes.md Outdated Show resolved Hide resolved

cmbz mentioned this pull request Mar 28, 2024

Feature Request/Idea: Native API access to upload collection logos and Theme specifications #10194

Open

jeromeroucou and others added 3 commits March 29, 2024 17:34

Update doc/release-notes/10433-release-notes.md

5fbdd31

Co-authored-by: Philip Durbin <philipdurbin@gmail.com>

Release note snippet update

d103370

Add new recommandations (HTML preview + "for more information ...")

Update SQL file name after 6.2 release

f5e54c8

cmbz added the Size: 10 A percentage of a sprint. 7 hours. label Apr 10, 2024

pdurbin assigned jeromeroucou Aug 5, 2024

pdurbin added the Status: Needs Input Applied to issues in need of input from someone currently unavailable label Aug 5, 2024

pdurbin self-assigned this Aug 27, 2024

luddaniel added 2 commits August 28, 2024 10:55

renamed sql file

a957fa6

Merge branch 'develop' into 10291-collection_thumbnail

33550da

cmbz added FY25 Sprint 4 FY25 Sprint 4 FY25 Sprint 5 FY25 sprint 5 labels Aug 28, 2024

Merge branch 'develop' into 10291-collection_thumbnail IQSS#10291

27f682f

pdurbin approved these changes Sep 4, 2024

View reviewed changes

pdurbin removed their assignment Sep 4, 2024

pdurbin unassigned jeromeroucou Sep 4, 2024

pdurbin removed the Status: Needs Input Applied to issues in need of input from someone currently unavailable label Sep 4, 2024

stevenwinship self-assigned this Sep 4, 2024

stevenwinship merged commit a8016aa into IQSS:develop Sep 4, 2024
14 checks passed

stevenwinship removed their assignment Sep 4, 2024

pdurbin added this to the 6.4 milestone Sep 4, 2024

jeromeroucou deleted the 10291-collection_thumbnail branch September 5, 2024 08:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add thumbnail for featured dataverses #10433

Add thumbnail for featured dataverses #10433

jeromeroucou commented Mar 27, 2024 •

edited by pdurbin

Loading

coveralls commented Mar 27, 2024 •

edited

Loading

pdurbin left a comment

pdurbin Mar 27, 2024

jeromeroucou Mar 27, 2024

pdurbin Mar 27, 2024

pdurbin Mar 27, 2024

jeromeroucou Mar 27, 2024

pdurbin left a comment

cmbz commented Mar 28, 2024

pdurbin commented Aug 5, 2024

DS-INRA commented Aug 7, 2024 •

edited

Loading

pdurbin commented Aug 27, 2024

luddaniel commented Aug 28, 2024 •

edited

Loading

pdurbin left a comment

pdurbin commented Sep 4, 2024

Add thumbnail for featured dataverses #10433

Add thumbnail for featured dataverses #10433

Conversation

jeromeroucou commented Mar 27, 2024 • edited by pdurbin Loading

coveralls commented Mar 27, 2024 • edited Loading

pdurbin left a comment

Choose a reason for hiding this comment

pdurbin Mar 27, 2024

Choose a reason for hiding this comment

jeromeroucou Mar 27, 2024

Choose a reason for hiding this comment

pdurbin Mar 27, 2024

Choose a reason for hiding this comment

pdurbin Mar 27, 2024

Choose a reason for hiding this comment

jeromeroucou Mar 27, 2024

Choose a reason for hiding this comment

pdurbin left a comment

Choose a reason for hiding this comment

cmbz commented Mar 28, 2024

pdurbin commented Aug 5, 2024

DS-INRA commented Aug 7, 2024 • edited Loading

pdurbin commented Aug 27, 2024

luddaniel commented Aug 28, 2024 • edited Loading

pdurbin left a comment

Choose a reason for hiding this comment

pdurbin commented Sep 4, 2024

jeromeroucou commented Mar 27, 2024 •

edited by pdurbin

Loading

coveralls commented Mar 27, 2024 •

edited

Loading

DS-INRA commented Aug 7, 2024 •

edited

Loading

luddaniel commented Aug 28, 2024 •

edited

Loading