Skip to content

Publication process

Jump to bottom
Thomas Vuillaume edited this page Jul 9, 2025 · 4 revisions

The catalog

Tools and services must be added to the catalog as JSON files describing their metadata. Some of the metadata are required, others are optional. The JSON file is validated by unit tests, they must pass.

Curation

To curate the tools and services, please:

  • make sure the tool or service is worth adding into the TechRadar. In particular, it should follow the criteria described in CONTRIBUTING.md.

  • make sure that the metadata are correctly filled and that they describe the tool or service accurately.

  • to help you decide on the Software Tier, please refer to https://zenodo.org/records/7248877 and use the low, medium and high levels. E.g. Version control concerns all tiers, while Risk analysis would be important to Research Infrastructure Software only.

You may request changes to the contribution to meet our requirements.

If the PR is accepted, you may merge it.

The contribution will not be visible in the TechRadar before the next release.

TechRadar releases

Regularly (every ~6 months), the curation team will process the catalogue to make a new release. Here are the steps:

  1. manually run the json-to-md script
  2. check that everything is fine for this new release, locally running the TechRadar and visually checking the result
  3. open PR to add new markdown files
    • merge when ready
    • these will appear as a new version in the TechRadar
  4. make a GitHub release
    • this should produce a new Zenodo record
Clone this wiki locally