Request for tool developers to check, correct and enrich their software metadata

[proycon]

Yesterday the following call to action was submitted via @roelandordelman,
aimed at CLARIAH tool developers with a request to check, correct and enrich
their software metadata (mail in dutch). I duplicate it here to track the issue
and its progress (this succeeds #38 and #91) and offer a space for possible general questions.

---

Beste CLARIAH tool ontwikkelaars, project- en werkpakketleiders,

Om onderzoekers en geïnteresseerden inzicht te geven in beschikbare tools die
ontwikkeld zijn in o.a. CLARIAH, verzamelen we alle informatie over tools in
onze “Tool Source Registry” (https://tools.clariah.nl/)

Vanuit deze registry zullen we vervolgens INEO voeden met een selectie van de
belangrijkste tools. Ook voor rapportages richting NWO zal de registry het
referentiepunt zijn. Goede beschrijvingen en compleetheid zijn dus essentieel
voor zowel vindbaarheid van de tools als projectverantwoording!

Eerder hebben we gevraagd om ervoor te zorgen dat in ieder geval alle in
CLARIAH geproduceerde/gefinancierde tools geregistreerd staan in de Tool
Source Registry. Updates worden dan automatisch geharvest. We willen nu een
stap verder gaan en alle werkpakketten en ontwikkelaars oproepen de kwaliteit
van de beschrijvingen, de software metadata, te verbeteren.

Je kunt zien hoe "de kwaliteit” van de beschrijving van een tool op dit
moment wordt geclassificeerd door naar de sterretjes te kijken op de index
pagina (onder metadata validation): je ziet een schaal van 0 (onvoldoende,
rood sterretje) via 3 (acceptabel, geel sterrtje) tot 5 (optimaal, groen
sterretje). Heel handig: Als je op een sterretje klikt wordt er automatisch
een validatierapport gemaakt die aangeeft welke metadata er nog ontbreekt om
een optimale score te krijgen voor dat niveau!

Dit validatierapport refereert aan punten uit de CLARIAH Software Metadata
Requirements die we hebben afgesproken en hier zijn te vinden als referentie:

https://github.com/CLARIAH/clariah-plus/blob/main/requirements/software-metadata-requirements.md

Dit document legt uit welke metadata je moet/kan/mag aanleveren en op welke
manier dat precies gaat. De punten in het document hangen nauw samen met de
CLARIAH Software Requirements die door het bestuur zijn vastgesteld.

We gaan ervan uit dat de tools die in CLARIAH-PLUS ontwikkeld zijn een score
van 3 of hoger zou moeten kunnen halen. Tools die hieraan voldoen zijn
bruikbaar genoeg om door te stromen naar INEO, schatten we. Tools met een
lagere scores komen waarschijnlijk (voorlopig) niet in de INEO etalage!

Voor vragen wijzen we naar de contribution guidelines van het CLARIAH Tool
Discovery project. Hierin hebben we een FAQ opgenomen die al de nodige vragen
beantwoordt:

https://github.com/CLARIAH/tool-discovery/blob/master/CONTRIBUTING.md

Mocht een tool überhaupt nog niet in de registry staan dan kan dat natuurlijk
altijd nog, volgens bovengenoemde instructies.

Een laatste verzoek: we hebben nog geen goed overzicht van iedereen die tools
ontwikkelen in CLARIAH dus graag doorsturen naar collega’s voor wie
bovenstaande relevant kan zijn.

[proycon]

@roelandordelman @jblom There is currently near to no metadata at all for MediaSuite (as there is no associated source repository and the user-facing website itself carries no metadata either). It now has 0 stars whilst it is a major project in CLARIAH that deserves to be represented well I think. Can we improve this?

[jblom]

@proycon we have to plan this work properly from our side, so we can decently open up all repositories that make the MS:

• clariah-mediasuite
• mediasuite-website
• labo-components
• labs-annotation-api
• labs-search-api
• labs-user-space-api
• labs-playout-proxy

The top three repos make up the application/website and the others are the underlying APIs