The HPC Portal is designed as an open and collaborative learning environment. Members of the HPC community are encouraged to actively contribute their own learning materials, documentation, tutorials, training concepts, and other educational resources. This documentation explains the technical structure of the platform, the workflow for contributing content, and the available contribution formats.
The HPC Portal is built using the static website generator Hugo. All website content, configuration files, and documentation are maintained in a central Git repository (Link only works on HSU campus or in HSU VPN). Access to the repository is provided via self-registration in GitLab.
The repository can either be:
Example commands:
# HTTPS
git clone https://git.hpc.hsu-hh.de/cbrz/hpc-portal.git
# SSH
git clone git@git.hpc.hsu-hh.de:cbrz/hpc-portal.git
Most content on the HPC Portal is written in Markdown.
Markdown is a lightweight markup language that allows contributors to write formatted content using simple syntax. It is especially suitable for documentation, tutorials, and educational material because it remains readable in plain text form.
Typical Markdown elements include:
# Heading
## Subheading
**Bold text**
- Bullet points
1. Lists
[Links](https://example.com)
Contributors are encouraged to familiarize themselves with basic Markdown syntax before editing or creating content.
To work with the repository and edit files locally, it is recommended to use a modern source-code editor or Integrated Development Environment (IDE). However, any plain text editor will be sufficient, depending on the complexity of your project.
Recommended tools include:
The browser-based Git editor is explicitly not recommended for larger edits or the creation of structured content, since it lacks many features necessary for comfortable editing, version control, and previewing.
After editing or creating files locally, contributions must be submitted through the Git workflow.
The general process is:
If you would like to contribute something but you do not have the time to manage the whole process, just send a markdown file to hpc-portal@hsu-hh.de.