Skip to content
Snippets Groups Projects
Commit c5abbe25 authored by Michael Bommhardt-Richter's avatar Michael Bommhardt-Richter
Browse files

Update doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md

parent 1292cf90
No related branches found
No related tags found
3 merge requests!831Bar,!828Bin mal die ganze Seite durchgegangen...,!823Bin mal die ganze Seite durchgegangen...
...@@ -99,8 +99,8 @@ your changes takes less time and your improvements appear faster on the official ...@@ -99,8 +99,8 @@ your changes takes less time and your improvements appear faster on the official
## Contribute via Issue ## Contribute via Issue
You can contribute to the documentation via the You can contribute to the documentation using
[GitLab issue tracking system](https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/hpc-compendium/-/issues). [GitLab's 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.
...@@ -118,21 +118,21 @@ documentation. ...@@ -118,21 +118,21 @@ documentation.
## Contribute via Web IDE ## Contribute via Web IDE
If you have a web browser (most probably you are using it to read this page) and want to contribute If you have a web browser (most probably you are using it to read this page) and want to contribute
to the documentation, you are good to go. GitLab offers a rich and versatile web interface to work to the documentation, you are good to go. GitLab offers a rich and versatile web interface for working
with repositories. To start fixing typos and edit source files, please find more information on the with repositories. To start fixing typos and edit source files, you can find more information on the
page [Contributing via web browser](contribute_browser.md). page [Contributing via web browser](contribute_browser.md).
## Contribute via Local Clone ## Contribute via Local Clone
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 the checks of the CI engine
used in the back-end. Using them should ensure that merge requests will not be blocked used in the backend. Using them should ensure that merge requests are not blocked
due to automatic checking. due to automatic checks.
The page on [Contributing via local clone](contribute_container.md) provides you with the details The page [Contributing via local clone](contribute_container.md) provides you with the details
about how to setup and use your local clone of the repository. about how to set up and use your local clone of the repository.
## CI/CD Pipeline ## CI/CD Pipeline
All contributions need to pass the CI pipeline which consists of various checks to ensure, that the All contributions need to pass through the CI pipeline which consists of various checks to ensure, that the
[content rules](content_rules.md) are met. [content rules](content_rules.md) are met.
The stages of the CI/CD pipeline are defined in a `.gitlab.yaml` file. For security reasons, this The stages of the CI/CD pipeline are defined in a `.gitlab.yaml` file. For security reasons, this
......
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