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 31105a5208932ff49ee86d939ed8faa744dad854..bd3206aa2484e92ca75374c74fec274febc37d78 100644 --- a/doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md +++ b/doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md @@ -4,14 +4,21 @@ Ink is better than the best memory. +In principle, there are three possible ways how to contribute to this documentation. + ## Contribute via Issue Users can contribute to the documentation via the [GitLab issue tracking system](https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/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 +wording etc. ZIH staff will get in touch with you to resolve the issue and improve the documentation. +??? tip "GIF: Create GitLab Issue" + +  + {: align=center} + !!! warning "HPC support" Non-documentation issues and requests need to be send as ticket to @@ -20,8 +27,14 @@ documentation. ## Contribute via Web IDE GitLab offers a rich and versatile web interface to work with repositories. To fix typos and edit -source files, just select the file of interest and click the `Edit` button. A text and commit -editor are invoked: Do your changes, add a meaningful commit message and commit the changes. +source files, follow these steps: + +1. Navigate to the repository at +[https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/hpc-compendium](https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/hpc-compendium) and log in. +1. Select the right branch. +1. Select the file of interest in `doc.zih.tu-dresden.de/docs/...` and click the `Edit` button. +1. A text and commit editor are invoked: Do your changes, add a meaningful commit message and commit + the changes. The more sophisticated integrated Web IDE is reached from the top level menu of the repository or by selecting any source file. @@ -29,12 +42,9 @@ by selecting any source file. Other git services might have an equivalent web interface to interact with the repository. Please refer to the corresponding documentation for further information. -<!--This option of contributing is only available for users of--> -<!--[gitlab.hrz.tu-chemnitz.de](https://gitlab.hrz.tu-chemnitz.de). Furthermore, --> - ## Contribute Using Git Locally For experienced Git users, we provide a Docker container that includes all checks of the CI engine used in the back-end. 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). +For details, refer to the page [Work Locally Using Containers](contribute_container.md). diff --git a/doc.zih.tu-dresden.de/docs/contrib/misc/create_gitlab_issue.gif b/doc.zih.tu-dresden.de/docs/contrib/misc/create_gitlab_issue.gif new file mode 100644 index 0000000000000000000000000000000000000000..cb4910897903283e43b21feadcdb2acf2f42c15e Binary files /dev/null and b/doc.zih.tu-dresden.de/docs/contrib/misc/create_gitlab_issue.gif differ