From 2f8e0138296b979c22f7ccbdd2443bf8485b54ae Mon Sep 17 00:00:00 2001 From: Martin Schroschk <martin.schroschk@tu-dresden.de> Date: Sun, 26 Sep 2021 22:02:11 +0200 Subject: [PATCH] Fix typos, add quite --- .../docs/contrib/howto_contribute.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) 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 d035fa33f..6f16e925f 100644 --- a/doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md +++ b/doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md @@ -1,15 +1,21 @@ -# How To Contribute +# How-To Contribute + +!!! cite "Chinese proverb" + + Ink is better than the best memory. ## Contribute via Issue Users can contribute to the documentation via the -[issue tracking system](https://gitlab.hrz.tu-chemnitz.de/zih/hpc-compendium/hpc-compendium/-/issues). +[GitLab issue tracking system](https://gitlab.hrz.tu-chemnitz.de/zih/hpc-compendium/hpc-compendium/-/issues). For that, open an issue to report typos and missing documentation or request for more precise wording etc. ZIH staff will get in touch with you to resolve the issue and improve the documentation. -**Reminder:** Non-documentation issues and requests need to be send as ticket to -[hpcsupport@zih.tu-dresden.de](mailto:hpcsupport@zih.tu-dresden.de). +!!! warning "HPC support" + + Non-documentation issues and requests need to be send as ticket to + [hpcsupport@zih.tu-dresden.de](mailto:hpcsupport@zih.tu-dresden.de). ## Contribute via Web IDE @@ -28,7 +34,7 @@ refer to the corresponding documentation for further information. ## Contribute Using Git Locally -For experienced Git users, we provide a Docker containier that includes all checks of the CI engine -used in the backend. Using them should ensure that mareg requests will not be blocked +For experienced Git users, we provide a Docker container that includes all checks of the CI engine +used in the backend. Using them should ensure that merge requests will not be blocked due to automatic checking. For details, see [Work Locally Using Containers](contribute_container.md). -- GitLab