diff --git a/doc.zih.tu-dresden.de/docs/archive/beegfs_on_demand.md b/doc.zih.tu-dresden.de/docs/archive/beegfs_on_demand.md
index 84a400f4906832a6b96deae582d0604b9e63a3fc..55a6e106dcc42a62050cc75759ccc943f2dd688c 100644
--- a/doc.zih.tu-dresden.de/docs/archive/beegfs_on_demand.md
+++ b/doc.zih.tu-dresden.de/docs/archive/beegfs_on_demand.md
@@ -1,4 +1,4 @@
-# BeeGFS Filesystem
+# BeeGFS Filesystem (Outdated)
!!! warning
diff --git a/doc.zih.tu-dresden.de/docs/archive/bioinformatics.md b/doc.zih.tu-dresden.de/docs/archive/bioinformatics.md
index 7d2335d93c4e095552b323cc1e09f42727d9db5e..f023572624c9af646ca5b332272990720dd4a5c9 100644
--- a/doc.zih.tu-dresden.de/docs/archive/bioinformatics.md
+++ b/doc.zih.tu-dresden.de/docs/archive/bioinformatics.md
@@ -1,4 +1,4 @@
-# Bioinformatics
+# Bioinformatics (Outdated)
!!! warning
diff --git a/doc.zih.tu-dresden.de/docs/archive/cxfs_end_of_support.md b/doc.zih.tu-dresden.de/docs/archive/cxfs_end_of_support.md
index 72db43fe2ee8b99103cb89dff4022b23bad5e258..10be6b2c8744c958ea714781f028a991ddb2c91d 100644
--- a/doc.zih.tu-dresden.de/docs/archive/cxfs_end_of_support.md
+++ b/doc.zih.tu-dresden.de/docs/archive/cxfs_end_of_support.md
@@ -1,4 +1,4 @@
-# Changes in the CXFS Filesystem
+# Changes in the CXFS Filesystem (Outdated)
!!! warning
diff --git a/doc.zih.tu-dresden.de/docs/archive/install_jupyter.md b/doc.zih.tu-dresden.de/docs/archive/install_jupyter.md
index a1d2966509244d71d32c7bfa22d74c18b45be628..89783636d7ba76dfd0825906eb26cc7e6582f906 100644
--- a/doc.zih.tu-dresden.de/docs/archive/install_jupyter.md
+++ b/doc.zih.tu-dresden.de/docs/archive/install_jupyter.md
@@ -1,4 +1,4 @@
-# Jupyter Installation
+# Jupyter Installation (Outdated)
!!! warning
diff --git a/doc.zih.tu-dresden.de/docs/archive/knl_nodes.md b/doc.zih.tu-dresden.de/docs/archive/knl_nodes.md
index ff7d4d9168e0a904e3e7258a18236cc65a9ea27b..c374e20d26ac15c5c9b7c2cbcdf0b96d690cfcd7 100644
--- a/doc.zih.tu-dresden.de/docs/archive/knl_nodes.md
+++ b/doc.zih.tu-dresden.de/docs/archive/knl_nodes.md
@@ -1,4 +1,4 @@
-# Intel Xeon Phi (Knights Landing)
+# Intel Xeon Phi (Knights Landing) (Outdated)
!!! warning
diff --git a/doc.zih.tu-dresden.de/docs/archive/load_leveler.md b/doc.zih.tu-dresden.de/docs/archive/load_leveler.md
index 7a96f4945d08650ca8c20592e140ab0f43bcfe16..7723f6baa455fc13ea114cdbf71c9e18ea69be87 100644
--- a/doc.zih.tu-dresden.de/docs/archive/load_leveler.md
+++ b/doc.zih.tu-dresden.de/docs/archive/load_leveler.md
@@ -1,4 +1,4 @@
-# LoadLeveler - IBM Tivoli Workload Scheduler
+# LoadLeveler - IBM Tivoli Workload Scheduler (Outdated)
!!! warning
diff --git a/doc.zih.tu-dresden.de/docs/archive/migrate_to_atlas.md b/doc.zih.tu-dresden.de/docs/archive/migrate_to_atlas.md
index 905f59a880cfafefa6633cdfdca3320feccd5b8f..c3c37852a10563d6a49f853af8a0b9b5767ac555 100644
--- a/doc.zih.tu-dresden.de/docs/archive/migrate_to_atlas.md
+++ b/doc.zih.tu-dresden.de/docs/archive/migrate_to_atlas.md
@@ -1,4 +1,4 @@
-# Migration from Deimos to Atlas
+# Migration from Deimos to Atlas (Outdated)
!!! warning
diff --git a/doc.zih.tu-dresden.de/docs/archive/no_ib_jobs.md b/doc.zih.tu-dresden.de/docs/archive/no_ib_jobs.md
index 49007a12354190a0fdde97a14a1a6bda922ea38d..79fb6dcdde89c460671c1b7adb9cc7f7101973ef 100644
--- a/doc.zih.tu-dresden.de/docs/archive/no_ib_jobs.md
+++ b/doc.zih.tu-dresden.de/docs/archive/no_ib_jobs.md
@@ -1,4 +1,4 @@
-# Jobs without Infiniband
+# Jobs without Infiniband (Outdated)
!!! warning
diff --git a/doc.zih.tu-dresden.de/docs/archive/overview.md b/doc.zih.tu-dresden.de/docs/archive/overview.md
index dfcb393a253c916a86ab21649aa75eb509ee2862..7cd1e76cb566ecf7821464f4cf7e2b9ef72dbc0a 100644
--- a/doc.zih.tu-dresden.de/docs/archive/overview.md
+++ b/doc.zih.tu-dresden.de/docs/archive/overview.md
@@ -1,4 +1,4 @@
-# Archive
+# Archive (Outdated)
A warm welcome to the **archive**. You probably got here by following a link from within the compendium
or by purpose.
diff --git a/doc.zih.tu-dresden.de/docs/archive/phase2_migration.md b/doc.zih.tu-dresden.de/docs/archive/phase2_migration.md
index 484b0196eb7de8e6aca1eb7927c6957899bacf87..55e6c007dde110f38f5a3bb56d5bc2ab992e09fc 100644
--- a/doc.zih.tu-dresden.de/docs/archive/phase2_migration.md
+++ b/doc.zih.tu-dresden.de/docs/archive/phase2_migration.md
@@ -1,4 +1,4 @@
-# Migration towards Phase 2
+# Migration towards Phase 2 (Outdated)
## How to copy your data from an old scratch (Atlas, Venus, Taurus I) to our new scratch (Taurus II)
diff --git a/doc.zih.tu-dresden.de/docs/archive/platform_lsf.md b/doc.zih.tu-dresden.de/docs/archive/platform_lsf.md
index e0c0b95764618c0585e4eaf07fcac3e1f3bb947e..3e3bdbe9d1ca130f50804ad3275ebe055f4971f7 100644
--- a/doc.zih.tu-dresden.de/docs/archive/platform_lsf.md
+++ b/doc.zih.tu-dresden.de/docs/archive/platform_lsf.md
@@ -1,4 +1,4 @@
-# Platform LSF
+# Platform LSF (Outdated)
!!! warning
This Page is deprecated!
diff --git a/doc.zih.tu-dresden.de/docs/archive/scs5_software.md b/doc.zih.tu-dresden.de/docs/archive/scs5_software.md
index b92903e75b766b52dde43963cbe883565608fda5..5fc53caf9c7682fb3588283a4fdabceec5026974 100644
--- a/doc.zih.tu-dresden.de/docs/archive/scs5_software.md
+++ b/doc.zih.tu-dresden.de/docs/archive/scs5_software.md
@@ -1,4 +1,4 @@
-# SCS5 Migration Hints
+# SCS5 Migration Hints (Outdated)
!!! warning
diff --git a/doc.zih.tu-dresden.de/docs/archive/system_altix.md b/doc.zih.tu-dresden.de/docs/archive/system_altix.md
index 08cc3a3e8f739780205ef7de75bcd618ee111dd9..0ba3c245aea097c8bdf7681ad59d87040c3dfe26 100644
--- a/doc.zih.tu-dresden.de/docs/archive/system_altix.md
+++ b/doc.zih.tu-dresden.de/docs/archive/system_altix.md
@@ -1,4 +1,4 @@
-# SGI Altix
+# SGI Altix (Outdated)
!!! warning
diff --git a/doc.zih.tu-dresden.de/docs/archive/system_atlas.md b/doc.zih.tu-dresden.de/docs/archive/system_atlas.md
index 2bebd5511e69f98370aea0c721cee272f940fbc6..f57024308f2a6f54d9f0e19d34b9a38937d8b6a9 100644
--- a/doc.zih.tu-dresden.de/docs/archive/system_atlas.md
+++ b/doc.zih.tu-dresden.de/docs/archive/system_atlas.md
@@ -1,4 +1,4 @@
-# MEGWARE PC-Farm Atlas
+# MEGWARE PC-Farm Atlas (Outdated)
!!! warning
diff --git a/doc.zih.tu-dresden.de/docs/archive/system_deimos.md b/doc.zih.tu-dresden.de/docs/archive/system_deimos.md
index a80890f070a92d5bcf6dc35205f72072e9ddd89a..66da7a2cc4e138780e6d7dfb850467343e9d84bc 100644
--- a/doc.zih.tu-dresden.de/docs/archive/system_deimos.md
+++ b/doc.zih.tu-dresden.de/docs/archive/system_deimos.md
@@ -1,4 +1,4 @@
-# Linux Networx PC-Farm Deimos
+# Linux Networx PC-Farm Deimos (Outdated)
!!! warning
diff --git a/doc.zih.tu-dresden.de/docs/archive/system_phobos.md b/doc.zih.tu-dresden.de/docs/archive/system_phobos.md
index bcd0d9cd88d758a643722669fcd50a6cbeaf99c5..008cf4f7c4c5e9ea5362edd5849437d011051d4c 100644
--- a/doc.zih.tu-dresden.de/docs/archive/system_phobos.md
+++ b/doc.zih.tu-dresden.de/docs/archive/system_phobos.md
@@ -1,4 +1,4 @@
-# Linux Networx PC-Cluster Phobos
+# Linux Networx PC-Cluster Phobos (Outdated)
!!! warning
diff --git a/doc.zih.tu-dresden.de/docs/archive/system_titan.md b/doc.zih.tu-dresden.de/docs/archive/system_titan.md
index d22c774c3a52e55794a398e5533962f62df231e4..2424f1a41ff653dbfb571bda719e57f4d10a6f45 100644
--- a/doc.zih.tu-dresden.de/docs/archive/system_titan.md
+++ b/doc.zih.tu-dresden.de/docs/archive/system_titan.md
@@ -1,4 +1,4 @@
-# Windows HPC Server 2008 Cluster Titan
+# Windows HPC Server 2008 Cluster Titan (Outdated)
!!! warning
diff --git a/doc.zih.tu-dresden.de/docs/archive/system_triton.md b/doc.zih.tu-dresden.de/docs/archive/system_triton.md
index ada59bfc14208f476752c023ed9fb4f2558e15e1..bd5aa7bfea573013e60054f6d3ec8d8654f18339 100644
--- a/doc.zih.tu-dresden.de/docs/archive/system_triton.md
+++ b/doc.zih.tu-dresden.de/docs/archive/system_triton.md
@@ -1,4 +1,4 @@
-# IBM-iDataPlex Cluster Trition
+# IBM-iDataPlex Cluster Trition (Outdated)
!!! warning
diff --git a/doc.zih.tu-dresden.de/docs/archive/system_venus.md b/doc.zih.tu-dresden.de/docs/archive/system_venus.md
index d641e3d0380dfe93f00bc4e5e6d67bc2cacf18f1..a3fa33107b7508589f12842b9183f8819a655de7 100644
--- a/doc.zih.tu-dresden.de/docs/archive/system_venus.md
+++ b/doc.zih.tu-dresden.de/docs/archive/system_venus.md
@@ -1,4 +1,4 @@
-# SGI UV2000 / Venus
+# SGI UV2000 / Venus (Outdated)
!!! warning
diff --git a/doc.zih.tu-dresden.de/docs/archive/systems_switched_off.md b/doc.zih.tu-dresden.de/docs/archive/systems_switched_off.md
index 0a9a50bb72c25b6920d41a66d2828ec57cd4c7b1..4f1319e046f05621aa155a64260fb4327942f4e1 100644
--- a/doc.zih.tu-dresden.de/docs/archive/systems_switched_off.md
+++ b/doc.zih.tu-dresden.de/docs/archive/systems_switched_off.md
@@ -1,4 +1,4 @@
-# Hardware
+# Hardware (Outdated)
HPC at ZIH has a quite long history and several systems have been installed and operated.
Documentation on former systems for future reference can be found on the following pages:
diff --git a/doc.zih.tu-dresden.de/docs/archive/unicore_rest_api.md b/doc.zih.tu-dresden.de/docs/archive/unicore_rest_api.md
index 839028f327e069e912f59ffb688ccd1f54b58a40..2d0ae507fb1fa838f03265c7fd8cfd64c0326864 100644
--- a/doc.zih.tu-dresden.de/docs/archive/unicore_rest_api.md
+++ b/doc.zih.tu-dresden.de/docs/archive/unicore_rest_api.md
@@ -1,4 +1,4 @@
-# UNICORE access via REST API
+# UNICORE access via REST API (Outdated)
!!! warning
diff --git a/doc.zih.tu-dresden.de/docs/archive/vampirtrace.md b/doc.zih.tu-dresden.de/docs/archive/vampirtrace.md
index edfa2a80f1b70902a5622f84d33efded97ee4dc3..e2b8030e0f47bc88378c29e80f8b27f13b4eada0 100644
--- a/doc.zih.tu-dresden.de/docs/archive/vampirtrace.md
+++ b/doc.zih.tu-dresden.de/docs/archive/vampirtrace.md
@@ -1,4 +1,4 @@
-# VampirTrace
+# VampirTrace (Outdated)
!!! warning
diff --git a/doc.zih.tu-dresden.de/docs/archive/windows_batch.md b/doc.zih.tu-dresden.de/docs/archive/windows_batch.md
index 577a7f3956d074975ef9fd65f1c4fb9568740d7c..df4e0b259cd1345ea2ae3c34496e5878e73e6c88 100644
--- a/doc.zih.tu-dresden.de/docs/archive/windows_batch.md
+++ b/doc.zih.tu-dresden.de/docs/archive/windows_batch.md
@@ -1,4 +1,4 @@
-# Batch System on the Windows HPC Server
+# Batch System on the Windows HPC Server (Outdated)
!!! warning
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 6f3303e98debc9888a25600121f14e086896b7a4..3d3082e8969d486934449020fd7118f37a036e5d 100644
--- a/doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md
+++ b/doc.zih.tu-dresden.de/docs/contrib/howto_contribute.md
@@ -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
diff --git a/doc.zih.tu-dresden.de/docs/index.md b/doc.zih.tu-dresden.de/docs/index.md
index 2100b7e36954b9ea8d48e474a8eecc552719beff..601c8c31960805b91160aff1af15a2ad18ebbb5f 100644
--- a/doc.zih.tu-dresden.de/docs/index.md
+++ b/doc.zih.tu-dresden.de/docs/index.md
@@ -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
diff --git a/doc.zih.tu-dresden.de/docs/quickstart/getting_started.md b/doc.zih.tu-dresden.de/docs/quickstart/getting_started.md
index de7a7fe87b2e264c168f309c9b4b3c6d4664f952..bf8110143149c25310eb2dc79f11e817591a95f1 100644
--- a/doc.zih.tu-dresden.de/docs/quickstart/getting_started.md
+++ b/doc.zih.tu-dresden.de/docs/quickstart/getting_started.md
@@ -58,7 +58,8 @@ This aspect is considered for all the following recommendations.
## Accessing the ZIH HPC System
The ZIH HPC system can be accessed only within the TU Dresden campus networks.
-Access from outside is possible by establishing a [VPN connection](https://tu-dresden.de/zih/dienste/service-katalog/arbeitsumgebung/zugang_datennetz/vpn#section-4).
+Access from outside is possible by establishing a
+[VPN connection](https://tu-dresden.de/zih/dienste/service-katalog/arbeitsumgebung/zugang_datennetz/vpn#section-4).
There are different ways to access the ZIH HPC system (which are described in more detail below),
depending on the user's needs and previous knowledge:
@@ -75,15 +76,15 @@ Next, the mentioned access methods are described step by step.
### JupyterHub
1. Access JupyterHub here [https://taurus.hrsk.tu-dresden.de/jupyter](https://taurus.hrsk.tu-dresden.de/jupyter).
-1. Start by clicking on the `Start my server` button and you will see two Spawner Options,
+1. Start by clicking on the button `Start My Server` and you will see two Spawner Options,
`Simple` and `Advanced`.
1. The `Simple` view offers a minimal selection of parameters to choose from. The `Advanced`
view gives more opportunities. To get started, choose the `Simple` view, follow the image below
for choice of parameters and then click `Spawn`
-
+
{: align="center"}
1. You will see:
-
+
1. Once it loads, you will see the possibility between opening a `Notebook`, `Console` or `Other`.
Note that you will now be working in your home directory as opposed to a specific workspace
(see [Data Management and Data Transfer](#data-management-and-data-transfer) section below for more details).
@@ -91,7 +92,7 @@ Note that you will now be working in your home directory as opposed to a specifi
!!! caution "Stopping session on JupyterHub"
Once you are done with your work on the ZIH HPC system, explicitly stop the session by logging
out by clicking `File` → `Log Out` → `Stop My Server`.
- Alternatively, choose `File` → `Hub control panel` → `Stop My Server`.
+ Alternatively, choose `File` → `Hub Control Panel` → `Stop My Server`.
Explore the [JupyterHub](../access/jupyterhub.md) page for more information.
diff --git a/doc.zih.tu-dresden.de/docs/quickstart/misc/jupyterhub-simple-2022-03.png b/doc.zih.tu-dresden.de/docs/quickstart/misc/jupyterhub-simple-2022-03.png
deleted file mode 100644
index 97e995c5d5a969fabad141ae0bb9769ae6a43596..0000000000000000000000000000000000000000
Binary files a/doc.zih.tu-dresden.de/docs/quickstart/misc/jupyterhub-simple-2022-03.png and /dev/null differ
diff --git a/doc.zih.tu-dresden.de/docs/quickstart/misc/jupyterhub-simple.png b/doc.zih.tu-dresden.de/docs/quickstart/misc/jupyterhub-simple.png
deleted file mode 100644
index a6d17858e232ce7c169859a658830fc558f6a95a..0000000000000000000000000000000000000000
Binary files a/doc.zih.tu-dresden.de/docs/quickstart/misc/jupyterhub-simple.png and /dev/null differ
diff --git a/doc.zih.tu-dresden.de/docs/quickstart/misc/jupyterhub-spawner-options.jpg b/doc.zih.tu-dresden.de/docs/quickstart/misc/jupyterhub-spawner-options.jpg
new file mode 100644
index 0000000000000000000000000000000000000000..4e7bbdec0fe5296c0bdc5da9492896db2ccc3045
Binary files /dev/null and b/doc.zih.tu-dresden.de/docs/quickstart/misc/jupyterhub-spawner-options.jpg differ
diff --git a/doc.zih.tu-dresden.de/docs/quickstart/misc/jupyterhub-spawning-2022-03.png b/doc.zih.tu-dresden.de/docs/quickstart/misc/jupyterhub-spawning-2022-03.png
deleted file mode 100644
index 5511a8b95bc8ff536af4551f5c31d7c6df7125f1..0000000000000000000000000000000000000000
Binary files a/doc.zih.tu-dresden.de/docs/quickstart/misc/jupyterhub-spawning-2022-03.png and /dev/null differ
diff --git a/doc.zih.tu-dresden.de/docs/quickstart/misc/jupyterhub-spawning.jpg b/doc.zih.tu-dresden.de/docs/quickstart/misc/jupyterhub-spawning.jpg
new file mode 100644
index 0000000000000000000000000000000000000000..61889775bc44e895bcb04efdfc0fa852f4dc7ae7
Binary files /dev/null and b/doc.zih.tu-dresden.de/docs/quickstart/misc/jupyterhub-spawning.jpg differ
diff --git a/doc.zih.tu-dresden.de/docs/quickstart/misc/jupyterhub-spawning.png b/doc.zih.tu-dresden.de/docs/quickstart/misc/jupyterhub-spawning.png
deleted file mode 100644
index 7e3fc0f6e41208e612b2ab54dfe435cb83b6db63..0000000000000000000000000000000000000000
Binary files a/doc.zih.tu-dresden.de/docs/quickstart/misc/jupyterhub-spawning.png and /dev/null differ
diff --git a/doc.zih.tu-dresden.de/util/README.md b/doc.zih.tu-dresden.de/util/README.md
deleted file mode 100644
index 63c9125cf19e711b12dd480741ad38050143393f..0000000000000000000000000000000000000000
--- a/doc.zih.tu-dresden.de/util/README.md
+++ /dev/null
@@ -1,117 +0,0 @@
-# Check Scripts
-
-Several checks are in place to ensure a high quality and consistent documentation. These checks are
-run within the CI/CD pipeline and changes are only deployed to the HPC compendium, if the checks are
-passed. Thus, we highly recommend running the checks locally before committing and posing a merge
-request.
-
-* Markdown linter
-* Check internal and external links
-* Check code and command examples
-* Check no floating pages and depth of page tree
-
-## Markdown Linter
-
-The [markdown linter client](https://github.com/igorshubovych/markdownlint-cli) helps to keep the
-markdown source code clean and consistent.
-
-Installation
-
-```Shell Session
-~ npm install markdownlint-cli
-```
-
-The configuration is stored in `.markdownlintrc`.
-The tool `markdownlint` can be run in dry or fix mode.
-The *dry* mode (default) only outputs findings, whereas in *fix* mode it resolves basic
-errors directly in the markdown files.
-
-```Shell Session
-~ cd doc.zih.tu-dresden.de/
-~ markdownlint [--fix] docs/index.md
-docs/index.md:8:131 MD013/line-length Line length [Expected: 130; Actual: 138]
-```
-
-Before committing, invoke the script `util/lint-changes.sh` which calls the markdownlint tool for all
-(git-)changed markdown files.
-
-```Shell Session
-~ sh util/lint-changes.sh
-hpc-compendium-2.0-gitlab-tudzih git:(master) ✗ sh util/lint-changes.sh
-README.md:6 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
-README.md:7 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 3]
-README.md:21 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
-README.md:22 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Why is this not at gitlab.hrz.tu-chemnitz.de?"]
-[8< 8<]
-```
-
-## Check Links
-
-No one likes dead links. Therefore, we check the internal and external links within the markdown
-source files. For that, the script `util/check-links.sh` and/or the tool
-[markdown-link-check](https://github.com/tcort/markdown-link-check) can be used.
-
-Installation
-
-```Shell Session
-~ npm install markdown-link-check
-```
-
-```Shell Session
-~ cd doc.zih.tu-dresden.de/
-~ markdown-link-check docs/index.md
-
-FILE: docs/index.md
-[✖] http://141.76.17.11/hpc-wiki/bin/view/Compendium
-[✓] https://docs.olcf.ornl.gov/
-[✓] https://nersc.gitlab.io/
-[✓] https://www.mkdocs.org/
-[✓] https://docs.gitlab.com/runner/
-[✓] https://docs.gitlab.com/ee/user/project/pages/
-[✖] CONTRIBUTE.md
-
-7 links checked.
-
-ERROR: 2 dead links found!
-[✖] http://141.76.17.11/hpc-wiki/bin/view/Compendium → Status: 0
-[✖] CONTRIBUTE.md → Status: 400
-```
-
-### Usage
-
-Check links within changed git-versioned markdown files, invoke
-
-```Shell Session
-~ sh doc.zih.tu-dresden.de/util/check-links.sh
-```
-
-from top-level directory.
-
-To check all markdown files for broken links, invoke
-
-```Shell Session
-~ find . -name \*.md -exec markdown-link-check -q {} \;
-```
-
-## Check Code and Commands
-
-All code blocks and commands should be runnable from a login node.
-
-**TODO:** Implement [Issue #9](#9)
-
-## Check Pages Structure
-
-The script `check-no-floating.sh` contains two checks. It first checks the hierarchy depth of the
-pages structure. By design, no page in the documentation should be lower than four levels w.r.t. top
-level, i.e., landing page. Secondly, the script tests if every markdown file is included in the
-navigation section within the `mkdocs.yaml` file of this project.
-
-### Usage
-
-```bash
-sh doc.zih.tu-dresden.de/utils/check-no-floating.sh doc.zih.tu-dresden.de
-```
-
-### Return codes
-
-* -1/255 if any error occurs, 0 otherwise
diff --git a/doc.zih.tu-dresden.de/util/check-templated-code-snippets.py b/doc.zih.tu-dresden.de/util/check-templated-code-snippets.py
index 51829691c01c3b214adb784e6fd5b033391e0e40..2e0cff01344d03f362b12b6a280170a773ef005b 100755
--- a/doc.zih.tu-dresden.de/util/check-templated-code-snippets.py
+++ b/doc.zih.tu-dresden.de/util/check-templated-code-snippets.py
@@ -14,16 +14,19 @@ CODE_MODE = 1
readMode = NORMAL_MODE
#We need to avoid matches for "#include <iostream>", "<Ctrl+D>", "<-" (typically in R) and "<594>" (VampirServer)
pattern = re.compile(r"(?<!#include )<(?!Ctrl\+)[^0-9 -][^<>']*>")
-with open(fileName) as f:
- lineNumber = 1
- for line in f:
- if "```" in line:
- # toggle read mode if we find a line with ```, so that we know that we are in a code block or not
- readMode = CODE_MODE if readMode == NORMAL_MODE else NORMAL_MODE
- strippedLine = line.strip()
- # We want tuples with lineNumber, the line itself, whether it is a code line, whether it contains a template (e. g. <FILENAME>) and the line again with all templats replaced by '\\S'
- lines.append((lineNumber, strippedLine, readMode, pattern.search(strippedLine) != None, pattern.sub(r"\\S*", escapeSomeSigns(strippedLine))))
- lineNumber += 1
+try:
+ with open(fileName) as f:
+ lineNumber = 1
+ for line in f:
+ if "```" in line:
+ # toggle read mode if we find a line with ```, so that we know that we are in a code block or not
+ readMode = CODE_MODE if readMode == NORMAL_MODE else NORMAL_MODE
+ strippedLine = line.strip()
+ # We want tuples with lineNumber, the line itself, whether it is a code line, whether it contains a template (e. g. <FILENAME>) and the line again with all templats replaced by '\\S'
+ lines.append((lineNumber, strippedLine, readMode, pattern.search(strippedLine) != None, pattern.sub(r"\\S*", escapeSomeSigns(strippedLine))))
+ lineNumber += 1
+except FileNotFoundError:
+ print(" File not found, probably deleted")
# those tuples with the CODE_MODE as field 2 represent code lines
codeLines = list(filter(lambda line: line[2] == CODE_MODE, lines))
# we take line number, the line and a regular expression from the those code lines which contain a template, call them templatedLines