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

Fix linkes to renamed file

parent 4907bb1f
No related branches found
No related tags found
2 merge requests!592Automated merge from preview to main,!554Content rules
...@@ -97,7 +97,7 @@ into the `preview` branch of the repository. ...@@ -97,7 +97,7 @@ into the `preview` branch of the repository.
As stated earlier, all changes undergo a review process. As stated earlier, all changes undergo a review process.
This covers automated checks contained in the CI/CD pipeline and the review by a maintainer. This covers automated checks contained in the CI/CD pipeline and the review by a maintainer.
This is to ensure the quality of all contributions, e. g. by checking our This is to ensure the quality of all contributions, e. g. by checking our
[content rules](content_guide_lines.md). [content rules](content_rules.md).
You can follow this process under You can follow this process under
[Merge requests](https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/hpc-compendium/-/merge_requests) [Merge requests](https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/hpc-compendium/-/merge_requests)
(where you initiated your merge request). (where you initiated your merge request).
......
...@@ -47,7 +47,7 @@ can [run checks locally](#run-the-proposed-checks-inside-container). ...@@ -47,7 +47,7 @@ can [run checks locally](#run-the-proposed-checks-inside-container).
!!! tip !!! tip
When you contribute, please follow our [content rules](content_guide_lines.md) to make incorporating When you contribute, please follow our [content rules](content_rules.md) to make incorporating
your changes easy. We also check these rules via continuous integration checks and/or reviews. your changes easy. We also check these rules via continuous integration checks and/or reviews.
You can find the details and commands to [preview your changes](#start-the-local-web-server) and You can find the details and commands to [preview your changes](#start-the-local-web-server) and
[apply checks](#run-the-proposed-checks-inside-container). [apply checks](#run-the-proposed-checks-inside-container).
...@@ -70,7 +70,7 @@ problems, such as changes in the Dockerfile or any script could. ...@@ -70,7 +70,7 @@ problems, such as changes in the Dockerfile or any script could.
1. The developer needs to fix things that were found by CI. 1. The developer needs to fix things that were found by CI.
1. The developer informs you about the MR or asks for your support while fixing the CI. 1. The developer informs you about the MR or asks for your support while fixing the CI.
When you follow our [content rules](content_guide_lines.md) and When you follow our [content rules](content_rules.md) and
[run checks locally](#run-the-proposed-checks-inside-container), you are making this process [run checks locally](#run-the-proposed-checks-inside-container), you are making this process
faster. faster.
...@@ -137,7 +137,7 @@ In our continuous integration (CI) pipeline, a merge request triggers the automa ...@@ -137,7 +137,7 @@ In our continuous integration (CI) pipeline, a merge request triggers the automa
* correct text format. * correct text format.
These checks ensure a high quality and consistency of the content and follow our These checks ensure a high quality and consistency of the content and follow our
[content rules](content_guide_lines.md). If one of them fails, the merge request will not be accepted. To [content rules](content_rules.md). If one of them fails, the merge request will not be accepted. To
prevent this, you can run these checks locally and adapt your files accordingly. prevent this, you can run these checks locally and adapt your files accordingly.
You are now ready to use the different checks, however we suggest to try the pre-commit hook. You are now ready to use the different checks, however we suggest to try the pre-commit hook.
......
...@@ -15,7 +15,7 @@ three possible ways how to contribute to this documentation. These ways are outl ...@@ -15,7 +15,7 @@ three possible ways how to contribute to this documentation. These ways are outl
## Content Guide Lines ## Content Guide Lines
To ensure a high-quality and consistent documentation and to make it easier for readers to To ensure a high-quality and consistent documentation and to make it easier for readers to
understand all content, we set some [content guide lines](content_guide_lines.md). Please follow understand all content, we set some [content guide lines](content_rules.md). Please follow
these rules regarding markdown syntax and writing style when contributing! Furthermore, reviewing 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 take less time and your improvements appear faster on the official documentation.
......
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