Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create training YAML data file using some training schema and populate with data #127

Open
anenadic opened this issue Dec 4, 2024 · 4 comments

Comments

@anenadic
Copy link
Contributor

anenadic commented Dec 4, 2024

Decide on a simple schema (use BioSchemas as superset) and add a few training resources that can be used to tag pages.

An example schema that may be sufficient for our needs may look like:

- description: A tutorial on software quality
  id: scikit-learn
  name: scikit-learn
  url: https://scikit-learn.org
  domain: [life sciences, biohealth]
  quality_indicator: [] # which quality indicators, if any, this training resource addresses 

Decide how to handle links to TeSS, if this training is included there - e.g. do we have an extra field tess_url.

The next step is to curate the task pages with training and add support for this, similar it exists for tools with the {% tool "tool name" %} directive from the elixir theme plugin.

@anenadic anenadic added this to the December 2024 sprint milestone Dec 4, 2024
@anenadic anenadic changed the title Create training.yml data file Create training.yml data file using some training schema and populate with data Dec 5, 2024
@anenadic
Copy link
Contributor Author

anenadic commented Dec 5, 2024

A suggestion is to use https://bioschemas.org/profiles/TrainingMaterial/1.0-RELEASE for training materials. I am of opinion that we need only a subset of this schema (i.e. the required fields) as RSQKit is not a repository/registry of training materials - we need to use training materials to tag relevant pages in RSQKit and point to relevant training (using the external links to an actual resource or its curated page in TeSS to better interlink with other infrastructure sites/tools).

@anenadic anenadic changed the title Create training.yml data file using some training schema and populate with data Create training YAML data file using some training schema and populate with data Dec 5, 2024
@dgarijo
Copy link
Contributor

dgarijo commented Dec 10, 2024

quality_indicator does not seem to be part of the schema. I agree with using a subset, as our main point is to point to the training resource, not create a training registry ourselves.

@anenadic
Copy link
Contributor Author

anenadic commented Dec 16, 2024

From discussion on 16 December 2024: the idea is to use mTeSS-X as the canonocal and single training portal and we use the existing tess property on tools. We can use the existing TeSS for the time being, but people should be registering training in TeSS (whichever instance is in use) as RSQKit is not a registry for training.

@dgarijo
Copy link
Contributor

dgarijo commented Dec 16, 2024

@anenadic and the relationship between the training material and dimension? Do we keep it here, or not?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants