TechRadar (WP3) x RSQKit (WP2) – Link to TechRadar Tools

[kennethrioja]

What is the topic of the new content?

Context
The EVERSE website is showcasing its services and the links they foster between WPs. This issue is to see how we can concretely link the TechRadar and the RSQKit: see EVERSE-ResearchSoftware/EVERSE-ResearchSoftware.github.io#158 (comment)

Goal
Making concrete links/redirections between the RSQKit (Tasks page) and the TechRadar (description of a tool).

Description of the new content

• In the Tasks pages, next to each Tool link (e.g., Docker in https://everse.software/RSQKit/ci_cd), add a See on TechRadar link that redirects to the Docker page of TechRadar (https://everse.software/TechRadar/Compatibility/docker_Compatibility/) -> this allows users to see related tools for a given Task
• In the RS Quality page, next to each RS quality of RSQKit (e.g., https://everse.software/RSQKit/rs_quality#compatibility), add See related tools on TechRadar link that redirects to the relevant RS quality in the TechRadar (https://everse.software/TechRadar/Compatibility/) -> this allows users to see related tools for a given quality indicator

Questions

• How to make less manual back and fourth and/or automatize it so that new content in both ways are automatically updated in both sides?

Section within RSQKit for the new content

• Tasks
• Quality dimensions & indicators

[kennethrioja]

Ultimately, both lists should coincide :

RSQKit: https://github.com/EVERSE-ResearchSoftware/RSQKit/blob/main/_data/tool_and_resource_list.yml
TechRadar: https://github.com/EVERSE-ResearchSoftware/TechRadar/tree/main/data/software-tools

[shoaibsufi]

Ultimately, both lists should coincide :

RSQKit: https://github.com/EVERSE-ResearchSoftware/RSQKit/blob/main/_data/tool_and_resource_list.yml TechRadar: https://github.com/EVERSE-ResearchSoftware/TechRadar/tree/main/data/software-tools

We have had a lot of discussion about this on RSQKit - and the following is the view from the RSQKit side:

• Where a tool exists in TechRadar that should be seen as the master source of information and be reflected in tools_and_resource_list.yml with the catalog: set to TechRadar (note there might be a period of time where previous descriptions of tools need to be migrated from RSQKit to TechRadar - as they are better descriptions) this script by @shraddha-bajare will be helpful for this - https://github.com/EVERSE-ResearchSoftware/RSQKit/tree/main/scripts/discrepancy_check
• There will be tools in RSQKit that don't get mentioned in TechRadar and that's ok - as they are more descriptive about the context of research software quality (e.g. a leading language, platform or library) rather than strictly a research software quality tool - in this case catalog: is set to RSQKit

[shoaibsufi]

What is the topic of the new content?

Context The EVERSE website is showcasing its services and the links they foster between WPs. This issue is to see how we can concretely link the TechRadar and the RSQKit: see EVERSE-ResearchSoftware/EVERSE-ResearchSoftware.github.io#158 (comment)

Goal Making concrete links/redirections between the RSQKit (Tasks page) and the TechRadar (description of a tool).

Description of the new content

• In the Tasks pages, next to each Tool link (e.g., Docker in https://everse.software/RSQKit/ci_cd), add a See on TechRadar link that redirects to the Docker page of TechRadar (https://everse.software/TechRadar/Compatibility/docker_Compatibility/) -> this allows users to see related tools for a given Task[ ] In the RS Quality page, next to each RS quality of RSQKit (e.g., https://everse.software/RSQKit/rs_quality#compatibility), add See related tools on TechRadar link that redirects to the relevant RS quality in the TechRadar (https://everse.software/TechRadar/Compatibility/) -> this allows users to see related tools for a given quality indicator

Questions

• How to make less manual back and fourth and/or automatize it so that new content in both ways are automatically updated in both sides?

Section within RSQKit for the new content

• Tasks
• Quality dimensions & indicators

The RSQKit Editorial Board spent some time at the 4th November EB meeting to discuss integration:

• TechRadar pages (e.g. https://everse.software/TechRadar/Reliability/pytest_Reliability/) link to pages on RSQKit where the tool is mentioned (e.g. https://everse.software/RSQKit/testing_software)
• RSQKit task pages should either be linked to dimensions or TechRadar should derive dimensions from the indicators mentioned on RSQKit task pages - this would allow TechRadar segment pages (e.g. https://everse.software/TechRadar/FAIRness/) to link to task pages that mention a particular indicator (which is part of a particular dimension) (e.g. https://everse.software/RSQKit/licensing_software)
• The RSQKit page https://everse.software/RSQKit/all_tools_and_resources should also link to the TechRadar entry for the tool where it exists (this will allow you to see similar or related tools) (see - https://rdmkit.elixir-europe.org/all_tools_and_resources)

These are in addition to the integration points mentioned above in the first comment.

[shoaibsufi]

What is the canonical link for a tool - they seem contextualised only:

e.g. for Tox

• https://everse.software/TechRadar/Interaction%20Capability/tox_Interaction_Capability/
• https://everse.software/TechRadar/Sustainability/tox_Sustainability/

e.g. Nix

• https://everse.software/TechRadar/Flexibility/nix_Flexibility/
• https://everse.software/TechRadar/Reliability/nix_Reliability/
• https://everse.software/TechRadar/Security/nix_Security/

We need a unique url to a tool to help with mapping from RSQKit to TechRadar

[kennethrioja]

The RSQKit Editorial Board spent some time at the 4th November EB meeting to discuss integration:

• TechRadar pages (e.g. https://everse.software/TechRadar/Reliability/pytest_Reliability/) link to pages on RSQKit where the tool is mentioned (e.g. https://everse.software/RSQKit/testing_software)

For this very example, there is also this RSQKit page : https://everse.software/RSQKit/task_automation_github_actions. Could we imagine something like this for this example? Or were you thinking about something more elaborated?

[kennethrioja]

• RSQKit task pages should either be linked to dimensions

If an RSQKit task page (what/why/how) already links to TechRadar tools (how++), I don't think that adding dimensions (what++) is a good 'call-to-action'.
Otherwise, when a dimension is cited on the RSQKit, then it can redirect to the TechRadar's dimensions page – and this allows another link between RSQKit and TechRadar.

or TechRadar should derive dimensions from the indicators mentioned on RSQKit task pages - this would allow TechRadar segment pages (e.g. https://everse.software/TechRadar/FAIRness/) to link to task pages that mention a particular indicator (which is part of a particular dimension) (e.g. https://everse.software/RSQKit/licensing_software)

I think this is more useful, when looking at the FAIRness TechRadar's page, the question I would like to answer and be guided through would be "What can I do and use to improve the FAIRness of my software?" -> and a link to the RSQKit page here would make sense and be a clear call-to-action. Again, would this be a reasonable way of seeing this in TechRadar?

[kennethrioja]

• The RSQKit page https://everse.software/RSQKit/all_tools_and_resources should also link to the TechRadar entry for the tool where it exists (this will allow you to see similar or related tools) (see - https://rdmkit.elixir-europe.org/all_tools_and_resources)

Indeed I was thinking about a column like the one in RDMKit!