Add new tool or resource

Way of working

The tools or resources you will find on pages are a selected set from a bigger list. This selection is based on the appearance of a tool or resource in the content of the page.

Since the Data life cycle pages do not list tools, no tools table will be present on these pages. Tool and resource mentions are allowed in the following sections: Your domain, Your role, Your tasks and Tool assembly.

The all_tools_and_resources list is based on the yaml file in the _data directory of the RDMkit repository. Tools and resources can be manually linked to FAIRsharing.org, Bio.tools and TeSS, but every week we also run a fully automatic check that links tools and resources with the corresponding registries. A GitHub Bot will generate a Pull Request (PR) with the new links added to the main data file of the website.

The main yaml file

Each tool or resource mentioned in the text has metadata stored in the main yaml file. The metadata block for each tool consists of 5 attributes:

• id: The ID of a tool, in kebab-case, lowercase with hyphens.
• name: the name of the tool or resource
• url: URL to the main page of the tool or resource, make sure to let the URL start with https://
• description: A short description of the tool or resource. Try to not use the characters " or '
• registry: 3 registries are supported: Bio.tools, FAIRsharing.org and TeSS. The keywords you can use respectively are: biotools, fairsharing, fairsharing-coll and tess, specifying the id or query with a colon. FAIRsharing collections have an ID that follows the pattern bsg-s000XXX. List registries under the registry attribute as key: value pairs. If no FAIRsharing ID, Bio.tools ID or TeSS query is available for a source, you can overwrite the automatic linking by adding ‘NA’ as a registry.

Example:

- id: github
  name: GitHub
  url: https://github.com
  description:
    Versioning system, used for sharing code, as well as for sharing of
    small data
  registry:
    tess: GitHub

What tool or resource can be added to the table

Tools and resources specifically mentioned in the text of the pages should be present in the main table.

Making changes

1. Make sure the tool you want to add is not already described in the yaml file. If so, go to step 3, if not, follow the next step.

2. Click on the pencil icon seen on GitHub of the main yaml file as described in our GitHub Guide. Add your tool or resource at the bottom of the file following the structure described in the The main yaml file section of this page. Make sure the indentation follows one of the previously listed items. In case of doubt, copy the content of the yaml file and paste it into an online yaml validator to check the format.

3. Copy the tool_id of the tool or resource

4. Add the right context on RDMkit for the tool by mentioning it somewhere in the text using the following syntax:

  
  {% tool "tool_id" %}
  

Example:

  
  {% tool "zenodo" %} is a powerful data publication service, which is supported by the European Commission and focused on research data, including supplemental material like software, tables, figures or slides.
  

Will give:

Zenodo is a powerful data publication service, which is supported by the European Commission and focused on research data, including supplemental material like software, tables, figures or slides.