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 17322f635a304c8b47a79923d84e1a3c900914ee..f054c5fa3594c219807e9eed301db0d43d610128 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 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 [Email](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 693229344e0eeee1d263899e906996b54cba207f..4a14f2d245a481e9a1a3cdfd2abccdd5a63efa4a 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 these 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. diff --git a/doc.zih.tu-dresden.de/docs/legal_notice.md b/doc.zih.tu-dresden.de/docs/legal_notice.md index 3c9432ecb16eaa0a2fae1a40da4217f92da8a454..e5029584f538f8d909d4bd6f0cf786b73e9872df 100644 --- a/doc.zih.tu-dresden.de/docs/legal_notice.md +++ b/doc.zih.tu-dresden.de/docs/legal_notice.md @@ -30,4 +30,4 @@ E-Mail: zih@tu-dresden.de This documentation and the repository have two licenses: * All documentation is licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/). -* All software components are licensed under [MIT license](https://opensource.org/licenses/MIT). +* All software components are licensed under [MIT license](license_mit.txt). diff --git a/doc.zih.tu-dresden.de/docs/license_mit.txt b/doc.zih.tu-dresden.de/docs/license_mit.txt new file mode 100644 index 0000000000000000000000000000000000000000..02c33cdf3c7a4f4ce54a670efc885018868f3f26 --- /dev/null +++ b/doc.zih.tu-dresden.de/docs/license_mit.txt @@ -0,0 +1,16 @@ +Copyright 2021, 2022 TU Dresden / ZIH + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and +associated documentation files (the "Software"), to deal in the Software without restriction, +including without limitation the rights to use, copy, modify, merge, publish, distribute, +sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial +portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT +NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES +OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.