From 5e08613e9b663c6bc6233e4b93222ac0d3cf9afe Mon Sep 17 00:00:00 2001 From: Martin Schroschk <martin.schroschk@tu-dresden.de> Date: Thu, 19 May 2022 09:22:41 +0200 Subject: [PATCH] Fix linkes to renamed file --- doc.zih.tu-dresden.de/docs/contrib/contribute_browser.md | 2 +- doc.zih.tu-dresden.de/docs/contrib/contribute_container.md | 6 +++--- doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc.zih.tu-dresden.de/docs/contrib/contribute_browser.md b/doc.zih.tu-dresden.de/docs/contrib/contribute_browser.md index 1926cac5c..0cca02d9d 100644 --- a/doc.zih.tu-dresden.de/docs/contrib/contribute_browser.md +++ b/doc.zih.tu-dresden.de/docs/contrib/contribute_browser.md @@ -97,7 +97,7 @@ into the `preview` branch of the repository. 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 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 [Merge requests](https://gitlab.hrz.tu-chemnitz.de/zih/hpcsupport/hpc-compendium/-/merge_requests) (where you initiated your merge request). diff --git a/doc.zih.tu-dresden.de/docs/contrib/contribute_container.md b/doc.zih.tu-dresden.de/docs/contrib/contribute_container.md index 3ff79fa64..f0d5fe56c 100644 --- a/doc.zih.tu-dresden.de/docs/contrib/contribute_container.md +++ b/doc.zih.tu-dresden.de/docs/contrib/contribute_container.md @@ -47,7 +47,7 @@ can [run checks locally](#run-the-proposed-checks-inside-container). !!! 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. 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). @@ -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 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 faster. @@ -137,7 +137,7 @@ In our continuous integration (CI) pipeline, a merge request triggers the automa * correct text format. 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. You are now ready to use the different checks, however we suggest to try the pre-commit hook. 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 044423e23..2e00602b0 100644 --- a/doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md +++ b/doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md @@ -15,7 +15,7 @@ three possible ways how to contribute to this documentation. These ways are outl ## Content Guide Lines 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 your changes take less time and your improvements appear faster on the official documentation. -- GitLab