Introduction to Git and GitLab

This repository contains the materials of the workshop Introduction to Git and GitLab. On this basis, the official HIFIS workshop website is built. In addition, instructors can use it to set up a workshop-specifc pad.

Website Content and Configuration

You require Python >= 3.10 and MkDocs to build the general workshop website. The reference dependencies are listed in requirements.txt which is generated via pip-tools.

The website consists of the following content:

• workshop_materials contains the whole website content.
• custom_theme contains the configuration of the HIFIS-specific theme.
• base.yml defines MkDocs options used for all HIFIS workshops.
• mkdocs.yml defines the specific MkDocs options for this workshop website.

Preparation

Please clone this repository and install the required dependencies. We assume that you have already installed a suitable Python version and that you use a virtual Python environment.

git clone <GIT REMOTE REPOSITORY URL>
pip install -r requirements.txt

Build the Website

You can build the website locally as follows:

mkdocs build

The result can be found in the sites directory.

In addition, you can directly serve the website via the integrated development server:

mkdocs serve

Synchronize with the template

The workshop materials project is based on this template. You can check for and apply template changes (e.g., a new website layout) with the help of cruft:

• Please run cruft check to find out about new template changes.
• Please run cruft update to view and apply them.

Contributors

Here you find the main contributors to the material:

• Tobias Schlauch
• Carina Haupt
• Michael Meinel
• Martin Stoffers
• Katrin Leinweber
• Benjamin Wolff
• Fredo Erxleben

Contributing

Please see the contribution guidelines for further information about how to contribute.

License

Please see the file LICENSE.md for further information about how the content in this repository is licensed.