CLARIAH / clariah-plus

This is the project planning repository for the CLARIAH-PLUS project. It groups all technical documents and discussions pertaining to CLARIAH-PLUS in a central place and should facilitate findability, transparency and project planning, for the project as a whole.
9 stars 6 forks source link

Populate tool source registry #91

Closed proycon closed 1 year ago

proycon commented 2 years ago

The CLARIAH tool source registry is the input for the harvester. It merely lists endpoints (git source repositories) and service endpoints to search for metadata. The registry is a simple set of configuration files maintained in this git repository: https://github.com/CLARIAH/tool-discovery

Adding new tools is done using a pull request (or direct push) as per the contribution guidelines. Tools from all institutes and work packages should be represented eventually. Currently, however, we're still in the early stages of development.

The below list tracks the progress:

proycon commented 2 years ago

A few tools have already been added by others; this is a request to all partners to just add their tools to the tool source registry now and check if the already existing metadata descriptions of yours tools (i.e. in files like setup.py, README.md, github descriptions, package.json etc) are accurate and up to date. At this stage, you do not need to bother to add a custom codemeta.json yet (but you may if you want to experiment with it already).

We want to see to what extent the automatic harvesting already suffices. In the next stage, partners will be requested to add CLARIAH-specific metadata.

The result of all harvesting can be seen on https://tools.dev.clariah.nl/ . Eventually all CLARIAH tools must be in this registry.