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

1170 dedicated highlights page #1171

Merged
merged 4 commits into from
Apr 25, 2024
Merged

Conversation

cmeessen
Copy link
Contributor

@cmeessen cmeessen commented Apr 16, 2024

Dedicated highlights page

Fixes #1170

Changes proposed in this pull request:

  • adds a dedicated page for software highlights
    image
  • the highlights are by default sorted "Latest featured", i.e. ascending position
  • the filters in the sidebar show only properties of the highlights
  • the software highlights page can be reached via a button below the highlights carousel
    image
  • note that the configuration for software highlights in settings.json changes slightly

How to test:

  • optionally: define software_highlights title and description in settings.json
  • docker compose down --volumes && docker compose build --parallel && docker compose up
  • in a second terminal window docker compose run data-generation
  • navigate to software overview
  • if there are no highlights, login as admin and add some
  • click on the "Browse all Highlights" button below the highlights carousel
  • verify that filters work correctly and offer options that correspond to the displayed highlights

Points to be regarded in followup PR:

  • how to configure the amount of highlights shown in the carousel (e.g. settings.json vs switch in admnin frontend?)
  • how to specify whether the "Browse all highlights" button is shown on software index page?
  • as an administrator, does it make sense when adding a new highlight, the position will have the highest number and that it has to be moved manually to position 1?

PR Checklist:

  • Increase version numbers in docker-compose.yml
  • Link to a GitHub issue
  • Update documentation
  • Tests

@cmeessen cmeessen force-pushed the 1170-dedicated-highlights-page branch 8 times, most recently from 63402e6 to fe67781 Compare April 18, 2024 09:12
@dmijatovic dmijatovic force-pushed the 1170-dedicated-highlights-page branch 3 times, most recently from 4d046fa to 9f70e1e Compare April 19, 2024 11:43
@dmijatovic
Copy link
Contributor

dmijatovic commented Apr 19, 2024

I made limit variable and added notification on the admin page. I set the limit to 5 items in settings.json.

image

@cmeessen, @jmaassen and @ewan-escience Can you validate please?

Copy link
Collaborator

@ewan-escience ewan-escience left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One typo, otherwise nice work.

documentation/docs/03-rsd-instance/03-administration.md Outdated Show resolved Hide resolved
@dmijatovic dmijatovic force-pushed the 1170-dedicated-highlights-page branch from 9f70e1e to 6d2cc38 Compare April 19, 2024 14:33
@cmeessen cmeessen marked this pull request as ready for review April 22, 2024 06:08
cmeessen and others added 4 commits April 22, 2024 14:34
chore: remove unused method
…uded in carousel on admin page

chore: fix typo in component name
docs: update documentation text to include limit
@dmijatovic dmijatovic force-pushed the 1170-dedicated-highlights-page branch from 6856f4d to edda030 Compare April 22, 2024 12:39
Copy link

sonarcloud bot commented Apr 22, 2024

Quality Gate Passed Quality Gate passed for 'rsd-database'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

Copy link

sonarcloud bot commented Apr 22, 2024

Quality Gate Failed Quality Gate failed for 'rsd-frontend'

Failed conditions
16.5% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud

@jmaassen
Copy link
Member

jmaassen commented Apr 24, 2024

Works well, so go ahead and merge.

Some points for improvement at a later time:

  • It would indeed be more convenient to always add the new highlights at the top position
  • On the "all software highlights" page, the default order is "newest first" which implies a chronological order. There is no timestamp of any kind on the highlight cards however? Do we want this?
  • When adding highlights, the search bar also shows results that are already highlighted. Adding them again gives an error. We should either not show these in the search result, or alternatively, adding them again means moving them to the top spot again?

@cmeessen cmeessen merged commit ed2c6e4 into main Apr 25, 2024
5 of 6 checks passed
@dmijatovic dmijatovic deleted the 1170-dedicated-highlights-page branch May 30, 2024 14:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Dedicated page for highlights
4 participants