Training-Materials

This repository is a collection of GTN compatible de.KCD / de.NBI training materials and learning pathways. The content is licensed under CC-BY-4.0.

Our training materials are designed to help researchers and data scientists learn how to effectively use cloud technologies for data management and processing.

About de.KCD

de.KCD is a cross-location and cross-domain contact point for teaching skills in handling data using cloud-based technologies, resources and methods for institutions and networked centers as well as for researchers at all career levels. You can find more information about de.KCD on our website. Please check it for upcoming events, news, and further information. Our main GitHub organization is deKCD.

de.KCD is linked through its members to the German Network for Bioinformatics Infrastructure (de.NBI).

Adding new content

If you want to contribute new material, please check our contribution guide! We welcome contributions from the community to expand our training materials and learning pathways.

Running the website locally

To run the website locally, you need to have Ruby and Bundler installed. After that, you can run the following commands:

```bash

Install the required gems

bundle install

Run the Jekyll server

bundle exec jekyll serve --trace --livereload ```

Alternatively, you can use the provided run.sh script to start the Jekyll server:

```bash

Make the script executable

chmod +x run.sh

Run the script

./run.sh ```

Then, open your web browser and navigate to http://localhost:4000/Training-Materials/ to view the website.

Running the containerized version

Currently images are being pushed to quay.io by hand. One can also run a local build by running docker compose -f compose.dev.yml up -d.

Things to consider with the containerized version

The image allows to retrieve webhooks from GitHub to update the state of the static jekyll site. One needs to set a webhook secret for this. A current test-installation is available here: https://dekcd.bi.denbi.de/training/, which is a work in progress (CSS not fully working at the moment). Webhooks can be sent to https://dekcd.bi.denbi.de/training/webhook. When running the container in a compose setup one needs to set the expected webhook secret in the environment: TRAINING_MATERIAL_WEBHOOK_SECRET=... The current haproxy-config looks like this: ``` backend dekcd_training http-request set-path %[path,regsub(^/training/?,/Training-Materials/)] server s1 training-test:4000 check resolvers docker resolve-prefer ipv4 init-addr none

backend dekcdtrainingwebhook http-request set-path %[path,regsub(^/training/webhook?,/webhook)] server s1 training-test:5000 check resolvers docker resolve-prefer ipv4 init-addr none `` withtraining-test` as the container running the jekyll-site.

Currently the webhook triggers a pull command on the main-branch of this repository. Within the container the pull gets triggered when the webhook-payload retrieved indicates a push or merge-events on the main-branch of this repository. The test webhook was triggered by a push from another repository.

Development with Devcontainer

We provide a devcontainer for easy development and testing of the website. You can find the devcontainer configuration in the .devcontainer directory. To use it, you need to have Visual Studio Code installed. Open the repository in VS Code and it will prompt you to reopen the folder in the container. After that, you can run the Jekyll server as described above.