Data

Tools

Indexes

Applications

Experiments

Open Source Science

elixir-trp-fair-training-handbook

Train-the-trainer handbook for making training materials FAIR

https://github.com/elixir-europe-training/elixir-trp-fair-training-handbook

Science Score: 49.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 4 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: plos.org, zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.2%) to scientific vocabulary
Last synced: 6 months ago · JSON representation

Repository

Train-the-trainer handbook for making training materials FAIR

Basic Info
Statistics
  • Stars: 22
  • Watchers: 11
  • Forks: 17
  • Open Issues: 26
  • Releases: 2
Created about 4 years ago · Last pushed 6 months ago
Metadata Files
Readme License Zenodo

README.md

FAIR-training-handbook

DOI

Any issues? Contact Geert van Geest (@GeertvanGeest)

How to contribute (for non-git gurus)

First, you will need to be able to edit this repository. Ask for permissions at the repository admins (currently Geert van Geest).

If you are authoring one of the chapters, the easy way to contribute would be to edit in the browser. Do this by:

  • navigating to your chapter at docs/chapters/ at the top of this page
  • clicking on your chapter's md file (e.g. chapter_10.md)
  • clicking on the edit buttion:

Now you can edit the markdown. Here is a tutorial on markdown basics. For more advanced functionality, visit the mkdocs material webpage. For example for information on how to display admonitions.

If you have finished, you can directly commit to main. In order to do that, write a commit message, and click the green button with Commit changes:

After commiting it will take ~30-60 seconds before the website is updated with your changes. The website is hosted at https://elixir-europe-training.github.io/ELIXIR-TrP-FAIR-training-handbook/.

Adding tables

If you want to build large tables, have a look at markdown tables generator.

Adding references

This website supports bibtex (pandoc style). In order to add a reference, add it in bibtex format to references.bib, cite it in your markdown document with [@refid] (for the ten simple rules paper this would be [@Garcia2020]), and at the bottom of the page add the line \bibliography. You can find an example in docs/index.md.

Aims

Building on the FAIR training handbook as outlined by the ELIXIR FAIR training group.

Please see the 10 simple rules for FAIR training materials publication.

Please contact Geert van Geest if you want to contribute to this repo.

If working locally

This website is generated with MkDocs, with the theme Material.

To host it locally, install MkDocs: bash pip install mkdocs

and Material: bash pip install mkdocs-material

Clone this repository to your local computer. Then, make the repository your current directory and type:

bash mkdocs serve

To host it locally.

Check it out with your browser at http://localhost:8000.

If you commit to the branch main (the default branch), the website will be automatically updated in 30-60 seconds.

This will generate a webpage at:

https://elixir-europe-training.github.io/ELIXIR-TrP-FAIR-training-handbook/

Owner

  • Name: ELIXIR Europe Training
  • Login: elixir-europe-training
  • Kind: organization

Life science training resources from the ELIXIR Training Platform.

GitHub Events

Total
  • Issues event: 6
  • Watch event: 1
  • Delete event: 2
  • Issue comment event: 6
  • Push event: 58
  • Pull request event: 9
  • Fork event: 1
  • Create event: 2
Last Year
  • Issues event: 6
  • Watch event: 1
  • Delete event: 2
  • Issue comment event: 6
  • Push event: 58
  • Pull request event: 9
  • Fork event: 1
  • Create event: 2

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 hour
  • Total issue authors: 0
  • Total pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 0
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 hour
  • Issue authors: 0
  • Pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 1
View more stats
Top Authors
Issue Authors
  • GeertvanGeest (10)
  • bpiereck (2)
  • selgebali (1)
Pull Request Authors
  • GeertvanGeest (14)
  • github-actions[bot] (5)
  • richelbilderbeek (1)
  • rolandkrause (1)
  • elinkronander (1)
Top Labels
Issue Labels
enhancement (1) chapter 10 (1) General (1)
Pull Request Labels

Dependencies

.github/workflows/render_page.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/template-sync.yml actions
  • AndreasAugustin/actions-template-sync v1.1.3 composite
  • actions/checkout v3 composite
requirements.txt pypi
  • mkdocs-bibtex *
  • mkdocs-material *
  • mkdocs-video *
  • neoteroi-mkdocs *
  • setuptools *