Skip to content
Snippets Groups Projects
Commit af95940d authored by Martin Schroschk's avatar Martin Schroschk
Browse files

Add hint about responsibility

parent cb9ae927
No related branches found
No related tags found
2 merge requests!542Automated merge from preview to main,!514Terms conditions
# Content Rules
**Remark:** Avoid using tabs both in markdown files and in `mkdocs.yaml`. Type spaces instead.
## Responsibility And License
This documentation and the repository have two licenses (cf. [Legal Notice](../legal_notice.md)):
* All documentation is licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).
* All software components are licensed under [MIT license](../license_mit.txt).
These licenses will also apply to your contributions.
!!! note
Each user is fully and solely responsible for the content he/she creates and has to ensure that
he/she has the right to create it under the laws which apply.
If you are in doubt, please contact us either via
[GitLab Issue](https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/hpc-compendium/-/issues)
or via [ticket](mailto:hpcsupport@zih.tu-dresden.de).
## New Page and Pages Structure
......@@ -50,6 +66,7 @@ should be highlighted, etc. Code examples, longer than half screen height should
## Writing Style
* Avoid using tabs both in markdown files and in `mkdocs.yaml`. Type spaces instead.
* Capitalize headings, e.g. *Exclusive Reservation of Hardware*
* Give keywords in link texts, e.g. [Code Blocks](#code-blocks-and-syntax-highlighting) is more
descriptive than [this subsection](#code-blocks-and-syntax-highlighting)
......
......@@ -4,7 +4,21 @@
Ink is better than the best memory.
In principle, there are three possible ways how to contribute to this documentation.
Even though we try to cover all aspects of working with the ZIH systems and keep the documentation
up to date, you might miss something. In principle, there are three possible ways how you can
contribute to this documentation as outlined below.
## Content Rules
To ensure a high-quality and consistent documentation and to make it easier for readers to
understand all content, we set some [content rules](content_rules.md). Please follow this rules when
contributing! Furthermore, reviewing your changes take less time and your improvements appear faster on
the official documentation.
!!! note
Each user is fully and solely responsible for the content he/she creates and has to ensure that
he/she has the right to create it under the laws which apply.
## Contribute via Issue
......@@ -38,9 +52,3 @@ used in the back-end. Using them should ensure that merge requests will not be b
due to automatic checking.
The page on [Contributing via local clone](contribute_container.md) provides you with the details
about how to setup and use your local clone.
## Content Rules
To ensure quality and to make it easier for readers to understand all content, we follow some
[content rules](content_rules.md). If you follow these rules, you can be sure, that reviews of
your changes take less time and your improvements appear faster on the official web site.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment