Create OpenEBench Research Software Story#547
Create OpenEBench Research Software Story#547sparkslabs merged 12 commits intoEVERSE-ResearchSoftware:mainfrom
Conversation
❌ Deploy Preview for everse-rsqkit-testing failed.
|
EvaMart
left a comment
There was a problem hiding this comment.
I reviewed the whole doc and made some comments. In general I think we need to add links to resources in the text and be a bit more specific sometimes.
✅ Deploy Preview for everse-rsqkit-testing ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
@shoaibsufi the pull request is ready for review! |
sparkslabs
left a comment
There was a problem hiding this comment.
Page reads well, overall - thank you!
However, the PR needs some rework - details below.
Things that need to be fixed before merge:
- The sub-heading needs deleting in these sections:
- Sustainability
- Developer Community
- Some of the inline links haven't been rendered correctly. For example where you have
README files for each repository explaining setup and usage [https://github.com/inab/openebench-hub], I think you meant to do:[README files for each repository explaining setup and usage](https://github.com/inab/openebench-hub)- There's quite a few of these.
- Links in the references section should be links (easiest: wrap in "<" and ">" eg -
<https://openebench.bsc.es/> - There's also currently a merge conflict which will prevents a merge, it would be worth taking a look at the messages.
Things that probably ought to be fixed before merge:
- Should be one sentence per line, not one paragraph per line. (simplifies maintenance)
- Metadata shouldn't contain comments in #'s
- FAIR - most stories break this out each part of FAIR as separate bullets. If someone is unaware of what FAIR stands for, and they read the page it both educates and illustrates the purpose -- eg https://everse.software/RSQKit/acts_research_software_story
Things that would be nice before merge: (could be follow on issue / PR)
- If you use a list of links at the end of the file, you can use the alternate syntax, which makes it easy to include a link in multiple places - see the end of this story for an example -- https://raw.githubusercontent.com/EVERSE-ResearchSoftware/RSQKit/refs/heads/main/pages/research_software_stories/baler_research_software_story.md
- This makes it easier to make the page more reader friendly :-)
- Also simplifies maintenance.
- deleted subheadings - changed inline links - Links in the references section improved - Metadata without comments in #'s - FAIR broken out as separate bullets
|
Thank you very much for the comments @sparkslabs
I can do that in another iteration of the page, I hope it doesn't prevent merging :) Thank you!! |
|
Hi @lauportell - I've taken a look and it looks great - thanks. I've taken your note about a later iteration, and captured your points here -- #585 So I'll be merging this. Thanks! |
Created a fork for OpenEBench Research Software story so that everyone from OpenEBench team can contribute.
This page requires review, updates, and possible additions by the OpenEBench technical team.
@scapella can you give a general review?
@jmfernandez, @abredondo can you review technical aspects?
@EvaMart can you review the information about the Observatory?
@Androidbeingx and @AniValle can you add the missing pieces for the Front-end?