Skip to content
Snippets Groups Projects
Commit ab441f99 authored by Jan Frenzel's avatar Jan Frenzel
Browse files

Changed few passive and impersonal phrases in contribution description.

parent 04e0b0f0
No related branches found
No related tags found
2 merge requests!602Automated merge from preview to main,!595Changed few passive and impersonal phrases in contribution description.
......@@ -8,8 +8,8 @@ This documentation is written in markdown and translated into static html pages
[mkdocs](https://www.mkdocs.org/). A single configuration file holds the pages structure
as well as specification of the theme and extensions. This file is `mkdocs.yaml`.
All essential files (markdown pages, graphics, configuration, theme, etc.) are managed within a Git
repository which makes it quite easy to contribute to this documentation. In principle, there are
We manage all essential files (markdown pages, graphics, configuration, theme, etc.) within a Git
repository, which makes it quite easy to contribute to this documentation. In principle, there are
three possible ways how to contribute to this documentation. These ways are outlined below.
## Content Guide Lines
......@@ -17,16 +17,16 @@ three possible ways how to contribute to this documentation. These ways are outl
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 regarding markdown syntax and writing style when contributing! Furthermore, reviewing
your changes take less time and your improvements appear faster on the official documentation.
your changes takes 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.
If you contribute, you are fully and solely responsible for the content you create and have to
ensure that you have the right to create it under the laws which apply.
## Contribute via Issue
Users can contribute to the documentation via the
You 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
......
......@@ -8,16 +8,17 @@ information.
## Contribution
Issues concerning this documentation can reported via the GitLab
Your contributions are highly welcome. The easiest way for you to contribute is to report issues via
the GitLab
[issue tracking system](https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/hpc-compendium/-/issues).
Please check for any already existing issue before submitting your issue in order to avoid duplicate
issues.
Your contributions are highly welcome. Please find out more in our [guidelines how to contribute](contrib/howto_contribute.md).
Please also find out the other ways you could contribute in our [guidelines how to contribute](contrib/howto_contribute.md).
!!! tip "Reminder"
Non-documentation issues and requests need to be send as ticket to
Non-documentation issues and requests need to be send to
[hpcsupport@zih.tu-dresden.de](mailto:hpcsupport@zih.tu-dresden.de).
## News
......
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