Merge branch 'review-check-links' of...

Merge branch 'review-check-links' of gitlab.hrz.tu-chemnitz.de:zih/hpcsupport/hpc-compendium into review-check-links

doc.zih.tu-dresden.de/docs/contrib/contribute_container.md

@@ -206,10 +206,9 @@ wikiscript doc.zih.tu-dresden.de/util/check-no-floating.sh doc.zih.tu-dresden.de
     No one likes dead links.
 
 Therefore, we check the internal and external links within the markdown source files.
-The script `doc.zih.tu-dresden.de/util/check-links.sh` allows to check a [single file](#single-file),
-all [all git-modified files](#all-git-modified-files) and
-[all markdown files of the compendium](#all-files). Please follow the instructions in the
-correspoding subsection.
+With the script `doc.zih.tu-dresden.de/util/check-links.sh`, you can either check
+[a single file](#single-file), [all modified files](#all-modified-files) or
+[all files](#all-files) of the compendium.
 
 ##### Single File
 
@@ -220,9 +219,9 @@ To check the links within a single file, e.g.
 wikiscript doc.zih.tu-dresden.de/util/check-links.sh docs/software/big_data_frameworks.md
 ```
 
-##### All Git-Modified Files
+##### All Modified Files
 
-The script can also check the links in all git-modified files, i.e., markdown files which are part
+The script can also check the links in all modified files, i.e., markdown files which are part
 of the repository and different to the `preview` branch. Use this script before committing your
 changes to make sure your commit passes the CI/CD pipeline.
 

doc.zih.tu-dresden.de/util/check-links.sh

@@ -20,8 +20,6 @@
 #     - html-proofer-plugin is quite slow, since it requires to build the whole compendium
 #       - html-proofer-plugin works on rendered html files
 #     - html-proofer-plugin has no option to check a single page
-#
-# Author: Martin.Schroschk@tu-dresden.de
 
 set -eo pipefail
 
@@ -36,7 +34,7 @@ usage: $0 [file | -a | -c]
 Options:
   <file>          Check links in the provided markdown file
   -a; --all       Check links in all markdown files
-  -i; --interal   Check links in all markdown files (internal links only)
+  -i; --internal   Check links in all markdown files (internal links only)
   -c; --changed   Check links in all git-changed files
 EOF
 }