Merge branch 'merge-preview-in-main' into 'main'

Automated merge from preview to main

See merge request !1045

Dockerfile

@@ -6,7 +6,7 @@ SHELL ["/bin/bash", "-c"]
 # Base #
 ########
 
-RUN pip install mkdocs>=1.1.2 mkdocs-material==8.5.11 mkdocs-htmlproofer-plugin==0.8.0 mkdocs-video==1.3.0
+RUN pip install mkdocs>=1.1.2 mkdocs-material==8.5.11 mkdocs-htmlproofer-plugin==1.2.1 mkdocs-video==1.3.0
 
 ##########
 # Linter #

doc.zih.tu-dresden.de/docs/access/ssh_mobaxterm.md

@@ -43,7 +43,7 @@ Here you can set different options in the following tabs:
     option, you can store and manage credentials. To access a different cluster, change the name
     accordingly (e.g.`login1.alpha.hpc.tu-dresden.de`)
 
-    ![Settings for SSH connection in MobaXterm](misc/mobaxterm5_ssh.png)
+    ![Settings for SSH connection in MobaXterm](misc/MobaXterm_remote_host.png)
 
 1.  Advanced settings can be configured in the same window below. These are
     - "Advanced SSH settings" - set defaults for this specific session. For example, set a SSH key
@@ -65,7 +65,7 @@ Here you can set different options in the following tabs:
 1.  The last thing to do is to input your ZIH password in the command line and to press enter.
     The entered symbols of your password are invisible and will not appear as typed in.
 
-    ![Saving your password in MobaXterm](misc/mobaxterm7_pw.png)
+    ![Saving your password in MobaXterm](misc/MobaXterm_password.png)
 
 !!! Caution
 

doc.zih.tu-dresden.de/docs/jobs_and_resources/barnard.md

@@ -57,7 +57,7 @@ The filesystems `/data/horse` and `/data/walrus` can only be accessed via worksp
 to the [workspace page](../data_lifecycle/workspaces.md), if you are not familiar with the
 workspace concept and the corresponding commands. You can find the settings for
 workspaces on these two filesystems in the
-[section Settings for Workspaces](../data_lifecycle/workspaces.md#settings-for-workspaces).
+[section Settings for Workspaces](../data_lifecycle/workspaces.md#workspace-lifetimes).
 
 ### Data Migration to New Filesystems
 

doc.zih.tu-dresden.de/docs/jobs_and_resources/overview.md

@@ -10,7 +10,7 @@ to achieve the ambitious research goals of the users and the ZIH.
 
 The HPC system, redesigned in December 2023, consists of five homogeneous clusters with their own
 [Slurm](slurm.md) instances and cluster specific
-[login nodes](hardware_overview.md#login-nodes). The clusters share one
+login nodes. The clusters share one
 [filesystem](../data_lifecycle/file_systems.md) which enables users to easily switch between the
 components.
 

doc.zih.tu-dresden.de/docs/quickstart/getting_started.md

@@ -400,7 +400,7 @@ For additional information refer to the detailed documentation on [modules](../s
 
     When explicitely loading multiple modules you need to make sure that they are compatible.
     So try to stick to modules using the same toolchain.
-    See the [Toolchains section](../software/modules.md#Toolchains) for more information.
+    See the [Toolchains section](../software/modules.md#toolchains) for more information.
 
 ## Running a Program/Job
 

doc.zih.tu-dresden.de/docs/software/data_analytics_with_r.md

@@ -36,7 +36,7 @@ marie@barnard$ Rscript </path/to/script/your_script.R> <param1> <param2>
 In addition to using interactive and batch jobs, it is possible to work with R using
 [JupyterHub](../access/jupyterhub.md).
 
-The production and test [environments](../access/jupyterhub.md#standard-environments) of
+The production and test [environments](../access/jupyterhub.md#standard-profiles) of
 JupyterHub contain R kernel. It can be started either in the notebook or in the console.
 
 ## RStudio

doc.zih.tu-dresden.de/docs/software/mathematics.md

@@ -124,7 +124,7 @@ marie@login$ module load MATLAB
 ```
 
 (then you will get the most recent MATLAB version.
-[Refer to the modules section for details.](../software/modules.md#modules))
+[Refer to the modules page for details.](modules.md#module-commands))
 
 ### Interactive MATLAB-GUI
 

doc.zih.tu-dresden.de/mkdocs.yml

@@ -225,18 +225,22 @@ plugins:
   - markdown-caption
   # https://github.com/manuzhang/mkdocs-htmlproofer-plugin
   - htmlproofer:
-      # True by default
-      # Toggle via env. var. ENABLED_HTMLPROOFER=false
+      # Disabled by default
+      # Enable via env. var. ENABLED_HTMLPROOFER=true
       enabled: !ENV [ENABLED_HTMLPROOFER, True]
-      # Check URLs before serving. Build fails in case of bad URLs.
-      raise_error: True
-      # Ignore errors
-      #raise_error_excludes:
-      #  504: ['https://www.mkdocs.org/']
+      # Check URLs before serving. Raise error and fail build at first bad URL.
+      # raise_error: !ENV [ENABLED_HTMLPROOFER_RE, False]
+      # Raise error and fail build after all URLs have been checked.
+      raise_error_after_finish: True
+      # Ignore certain urls
+      ignore_urls:
+          - mailto:hpc-support@tu-dresden.de
+          - https://jupyterhub.hpc.tu-dresden.de*
+      skip_downloads: True
       # Toggle validating external URLs
-      validate_external_urls: False
+      validate_external_urls: !ENV [ENABLED_HTMLPROOFER_EXTERNAL_URLS, False]
       # Validate the entire rendered template, slow!
-      validate_rendered_template: True
+      #validate_rendered_template: True
   - mkdocs-video:
       is_video: True
 

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

 #!/bin/bash
-## Purpose:
-##   Checks internal links for all (git-)changed markdown files (.md) of the repository.
+
+# Purpose:
+#   Checks internal and external links for all markdown files (.md) of the repository.
+#   For link checking, we use html-proofer-plugin, which is configured in mkdocs.yml.
+#   By default the link checker only inspects internal links. It will inspect internal and external
+#   links, when the env. variable ENABLED_HTMLPROOFER_EXTERNAL_URLS is set to true.
 
 set -eo pipefail
 
 export ENABLED_HTMLPROOFER=true
+
+function usage(){
+cat << EOF
+$0 [options]
+Check links in documentation.
+
+Options:
+  -a    Check internal and external links (default: internal links only)
+  -h    Show help message
+EOF
+}
+
+while getopts ":a" option; do
+  case ${option} in
+    a)
+      export ENABLED_HTMLPROOFER_EXTERNAL_URLS=true
+      echo "Info: Checking internal and external links. Might take some time."
+      ;;
+    h)
+      usage
+      exit;;
+    \?)
+      echo "Error: Invalid option."
+      usage
+      exit;;
+  esac
+done
+
+# Switch for wikiscript
+if [ -d "doc.zih.tu-dresden.de" ]; then
+  cd doc.zih.tu-dresden.de
+fi
+
 mkdocs build
 rm -rf public