Skip to content

elixir-europe-training/ELIXIR-Training-SPLASH

Repository files navigation

SPLASH

The ELIXIR Training SPLASH has been designed to guide the trainer in their efforts to plan, design, develop, deliver and evaluate training activties. It is based on the various steps of the training lifecycle, although not all the steps will be relevant to everyone.

The contents are generated and maintained by the ELIXIR Training platform ELIXIR-TrP. We want to sustain and govern ELIXIR Training SPLASH via the ELIXIR Programme 2024+.

SPLASH is short for

Skills,
Professional development,
Learning Assessment,
Support and
Help

along the training lifecycle.

Contribute

ELIXIR SPLASH is an open community project, and you are welcome to join us! The content of the material is developed in Markdown and a templating system (Jekyll) is used to format the Markdown pages and generate a website at https://elixir-europe-training.github.io/ELIXIR-Training-SPLASH/.

Do you want to help with this project? Please check out following pages for more information:

Do you wish to contact the editors of this project? Use [email protected]

License

The process documents and data are made available under a CC-BY license. Software are made available under an MIT license. More information about our license can be found on our license page.

Acknowledgements

ELIXIR SPLASH is supported by ELIXIR Europe.

Custom icons

We would like to thank Christof De Bo for creating the custom icons for the SPLASH. The icons are shared with the CC-BY 4.0 license. His work has added to the visual appeal and usability of our toolkit.



Built with the theme badge

Running locally

For detailed instructions on running the site locally (with or without Docker), see our technical documentation.

Quick start with Docker

This repository ships a Dockerfile and a Compose configuration so you can run and develop the site locally without installing Ruby, Jekyll and the gems on your host machine.

Prerequisites: Docker Desktop (or any recent Docker Engine) installed and running on your machine.

# build the jekyll image (use --no-cache if you want a clean rebuild)
docker compose build jekyll

# start the service
docker compose up -d jekyll

# tail the logs to watch the server start and rebuilds
docker compose logs --tail=200 --follow jekyll

Once the container reports "Server address: http://0.0.0.0:4000" you can open http://localhost:4000 in your browser.

Notes:

  • If you change the Gemfile or Gemfile.lock you must rebuild the image (docker compose build jekyll) so the image has the correct gems installed.
  • The repository is mounted into the container so file edits on your host will trigger Jekyll auto-regeneration inside the container. Use Ctrl+C to stop the container or docker compose down to stop and remove the container.