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

Improve documentation on how to create issue

parent f5b7f51c
No related branches found
No related tags found
3 merge requests!392Merge preview into contrib guide for browser users,!387Merge preview into main,!384Improve documentation on how to create issue
...@@ -4,14 +4,21 @@ ...@@ -4,14 +4,21 @@
Ink is better than the best memory. Ink is better than the best memory.
In principle, there are three possible ways how to contribute to this documentation.
## Contribute via Issue ## Contribute via Issue
Users can contribute to the documentation via the Users can contribute to the documentation via the
[GitLab issue tracking system](https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/hpc-compendium/-/issues). [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 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. documentation.
??? tip "GIF: Create GitLab Issue"
![Something](misc/create_gitlab_issue.gif)
{: align=center}
!!! warning "HPC support" !!! warning "HPC support"
Non-documentation issues and requests need to be send as ticket to Non-documentation issues and requests need to be send as ticket to
...@@ -20,8 +27,14 @@ documentation. ...@@ -20,8 +27,14 @@ documentation.
## Contribute via Web IDE ## Contribute via Web IDE
GitLab offers a rich and versatile web interface to work with repositories. To fix typos and edit 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 source files, follow these steps:
editor are invoked: Do your changes, add a meaningful commit message and commit the changes.
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 The more sophisticated integrated Web IDE is reached from the top level menu of the repository or
by selecting any source file. by selecting any source file.
...@@ -29,12 +42,9 @@ 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 Other git services might have an equivalent web interface to interact with the repository. Please
refer to the corresponding documentation for further information. 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 ## Contribute Using Git Locally
For experienced Git users, we provide a Docker container that includes all checks of the CI engine 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 used in the back-end. Using them should ensure that merge requests will not be blocked
due to automatic checking. 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).
doc.zih.tu-dresden.de/docs/contrib/misc/create_gitlab_issue.gif

660 KiB

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