dmijatovic commented 5 months ago

Edit software and project mentions pages

Closes #1121 Closes #1076 Closes #1115

Changes proposed in this pull request:

One menu options "Mentions" instead of two (mentions and reference papers)
Three tabs on the page: reference papers, citations, related output
This PR includes both software and project mentions!

How to test:

make start to build and generate test data
login as rsd_admin, create new software or edit existing
add reference papers:
- doi:10.1186/s13321-017-0220-4
- 10.1186/1758-2946-6-3
- https://doi.org/10.1021/ja026939x
add, import, create related output
- for import use the list from this issue
validate citations are scraped (ensure scrapers are running in dev)
create new project or edit existing project
add output and impact items manually
observe the scrapers generating citations based on the items added to output
test adding manual items and import

Edit software mentions

Edit project mentions

PR Checklist:

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

jmaassen commented 5 months ago

Some text improvements for the software mentions:

At reference papers:

"Here you can add reference papers which describe your software. The RSD will periodically look for citations of these papers using OpenAlex and add them to the citations list on this page."

At citations:

"Here we list all the citations of your reference papers that the RSD was able to find automatically. On the software page these citations are shown in the mentions section together with any items you have manually added in the related output section."

At related output:

"Here you can add research output related to your software that cannot be found automatically by the RSD, such as publications that do not cite your software or reference papers directly, presentations, blogs, tutorials, news articles, videos, policy documents, etc."

jmaassen commented 5 months ago

The deduplication between reference papers and scraped mentions isn't 100% correct yet. For example, "Kernel Tuner" has the following reference papers:

10.1109/tevc.2022.3210654 10.1016/j.future.2018.08.004 10.1109/pmbs54543.2021.00017 10.1109/pmbs56514.2022.00010

After the scrapers have run, there are 49 citations found. However, these also include (at least) these two papers:

10.1109/pmbs54543.2021.00017 10.1109/pmbs56514.2022.00010

So these show up twice in the final software page, once in reference papers and once in mentions

cmeessen commented 5 months ago

I think the UI reduction is a good step forward to make using the RSD more intuitive :+1: I could imagine that some users may be confused because the reference papers item is not appearing in the sidebar anymore. Would it make sense to add a notification somehow? Maybe a news item would be helpful too, but I think this is still WIP?

jmaassen commented 5 months ago

More text changes:

For software/reference papers:

"Here you can add reference papers that describe your software. The RSD will periodically look for citations of these papers using OpenAlex and add them to the citations list on this page."

On software/related output:

"Here you can add research output related to your software that cannot be found automatically by the RSD, such as papers, presentations, blogs, tutorials, news articles, videos, policy documents, etc. On the software page this output is shown in the mentions section together with citations that have been found automatically."

Also on software/related output:

"No mentions to show" -> "No related output to show"

jmaassen commented 5 months ago

On projects/citations:

"these citations are showed in" -> "these citations are shown in"

On projects/impact:

"Here you can add mentions of your project that cannot be found automatically by the RSD. These can be papers by others re-using your project results, press articles or videos highlighting the project, policy documents, etc."

sonarcloud[bot] commented 5 months ago

Quality Gate passed for 'authentication'

Issues
10 New issues

Measures
0 Security Hotspots
40.5% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

dmijatovic commented 5 months ago

@jmaassen, @ewan-escience, @cmeessen I have refactored mention section in order to improve user experience during tab switch. In this version we only load first 50 items per group in order to speed up loading. Can you please review this version?

sonarcloud[bot] commented 5 months ago