From af95940dc7d40e47153b8f8c60ae5187994aa3f9 Mon Sep 17 00:00:00 2001 From: Martin Schroschk <martin.schroschk@tu-dresden.de> Date: Mon, 7 Mar 2022 12:22:00 +0100 Subject: [PATCH] Add hint about responsibility --- .../docs/contrib/content_rules.md | 19 +++++++++++++++- .../docs/contrib/howto_contribute.md | 22 +++++++++++++------ 2 files changed, 33 insertions(+), 8 deletions(-) diff --git a/doc.zih.tu-dresden.de/docs/contrib/content_rules.md b/doc.zih.tu-dresden.de/docs/contrib/content_rules.md index b4c84ff84..b4f96267c 100644 --- a/doc.zih.tu-dresden.de/docs/contrib/content_rules.md +++ b/doc.zih.tu-dresden.de/docs/contrib/content_rules.md @@ -1,6 +1,22 @@ # 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) diff --git a/doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md b/doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md index 0bf7f02c5..ac608fd32 100644 --- a/doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md +++ b/doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md @@ -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. -- GitLab