README.md 1.5 KB
Newer Older
1
2
# ZIH HPC Documentation

Martin Schroschk's avatar
Martin Schroschk committed
3
4
This repository contains the documentation of the HPC systems and services provided at
[TU Dresden/ZIH](https://tu-dresden.de/zih/).
5
6
7
8
9
10

## Setup

We decided against a classical wiki software. Instead, we make use of the static site generator
[mkdocs](https://www.mkdocs.org/). It creates static html files from markdown source files. All
(configuration, layout and content) files will be managed within this git repository. The
Martin Schroschk's avatar
Martin Schroschk committed
11
12
13
documentation pages and configuration files are found in the folder `doc.zih.tu-dresden.de`. The
generated static html files, i.e, the documentation, is deployed to a web server. Several checks
within the CI/CD pipeline help to ensure a high quality documentation.
14
15
16

## Reporting Issues

Martin Schroschk's avatar
Martin Schroschk committed
17
Issues concerning this documentation can reported via the GitLab
18
[issue tracking system](https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/hpc-compendium/-/issues).
Martin Schroschk's avatar
Martin Schroschk committed
19
Please check for any already existing issue before submitting your issue in order to avoid duplicate
Martin Schroschk's avatar
Martin Schroschk committed
20
issues.
21
22
23
24
25
26

**Reminder:** Non-documentation issues and requests need to be send as ticket to
[hpcsupport@zih.tu-dresden.de](mailto:hpcsupport@zih.tu-dresden.de).

## Contributing

Martin Schroschk's avatar
Martin Schroschk committed
27
Contributions from user-side are highly welcome. Please refer to
Jan Frenzel's avatar
Jan Frenzel committed
28
[Contribution guide](doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md) to get started.
29
30
31

## Licenses

Martin Schroschk's avatar
Martin Schroschk committed
32
The repository has two licenses:
33

Martin Schroschk's avatar
Martin Schroschk committed
34
* All documentation is licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)
Martin Schroschk's avatar
Martin Schroschk committed
35
* All software components are licensed under MIT license.