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

doc.zih.tu-dresden.de/docs/data_lifecycle/workspaces.md

@@ -532,8 +532,18 @@ to others (if in the same group) via `ws_list -g`.
 set values that are not valid on our ZIH systems. You should overwrite `LC_CTYPE` and set it to a
 valid locale value like `export LC_CTYPE=de_DE.UTF-8`.
 
-A list of valid locales can be retrieved via `locale -a`. Please only use `UTF-8` (or plain) settings.
-Avoid "iso" codepages!
+A list of valid locales can be retrieved via `locale -a`.
+
+Please use `language_CountryCode.UTF-8` (or plain) settings. Avoid "iso" codepages!
+
+Examples:
+
+| Language | Code |
+| -------- | ---- |
+| Chinese - Simplified | zh_CN.UTF-8 |
+| English | en_US.UTF-8 |
+| French | fr_FR.UTF-8 |
+| German | de_DE.UTF-8 |
 
 ----
 

doc.zih.tu-dresden.de/util/check-every-page-not-included-more-than-once.sh

+#!/bin/bash
+scriptpath=${BASH_SOURCE[0]}
+basedir=$(dirname "${scriptpath}")
+basedir=$(dirname "${basedir}")
+DOCUMENT_ROOT=${basedir}/docs
+
+MSG=$(find ${DOCUMENT_ROOT} -name "*.md" | while IFS=' ' read string
+  do
+    md=${string#${DOCUMENT_ROOT}/}
+
+    # count occurences of md in nav 
+    numberOfReferences=$(sed -n '/nav:/,/^$/p' ${basedir}/mkdocs.yml \
+      | grep -c ${md})
+    if [[ ${numberOfReferences} -gt 1 ]]; then
+      echo "${md} is included ${numberOfReferences} times in nav"
+    fi
+  done
+)
+if [[ ! -z "${MSG}" ]]; then
+  echo "${MSG}"
+  exit 1
+fi

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

+#!/bin/bash
+scriptpath=${BASH_SOURCE[0]}
+basedir=$(dirname "${scriptpath}")
+basedir=$(dirname "${basedir}")
+DOCUMENT_ROOT=${basedir}/docs
+expectedFooter="\
+legal_notice.md \
+accessibility.md \
+data_protection_declaration.md"
+
+MSG=$(for md in ${expectedFooter}
+  do
+    # md included in footer 
+    numberOfReferencesInFooter=$(sed -n '/footer:/,/^$/p' \
+      ${basedir}/mkdocs.yml | grep -c /${md%.md})
+    if [[ ${numberOfReferencesInFooter} -eq 0 ]]; then
+      echo "${md} is not included in footer"
+    elif [[ ${numberOfReferencesInFooter} -ne 1 ]]; then
+      echo "${md} is included ${numberOfReferencesInFooter} times in footer"
+    fi
+  done
+)
+if [[ ! -z "${MSG}" ]]; then
+  echo "${MSG}"
+  exit 1
+fi

doc.zih.tu-dresden.de/util/check-max-depth.sh

+#!/bin/bash
+scriptpath=${BASH_SOURCE[0]}
+basedir=$(dirname "${scriptpath}")
+basedir=$(dirname "${basedir}")
+DOCUMENT_ROOT=${basedir}/docs
+# there should be at most one directory between the root directory and the page
+maxDepth=1
+DOCUMENT_SLASH_COUNT=$(echo "${DOCUMENT_ROOT}/" | awk -F'/' '{print NF}')
+
+MSG=$(find ${DOCUMENT_ROOT} -name "*.md" | awk -F'/' '{print $0,NF}' \
+  | while IFS=' ' read string slash_count
+  do
+    depth=$((slash_count - DOCUMENT_SLASH_COUNT))
+    if [[ "${depth}" -gt ${maxDepth} ]]; then
+      echo "max depth (${maxDepth}) exceeded for ${string}"
+    fi
+  done
+)
+if [[ ! -z "${MSG}" ]]; then
+  echo "${MSG}"
+  exit 1
+fi

doc.zih.tu-dresden.de/util/check-no-floating.sh

 #!/bin/bash
-
-if [ ${#} -ne 1 ]; then
-  echo "Usage: ${0} <path>"
-fi
-
-basedir=${1}
+scriptpath=${BASH_SOURCE[0]}
+basedir=$(dirname "${scriptpath}")
+basedir=$(dirname "${basedir}")
 DOCUMENT_ROOT=${basedir}/docs
-maxDepth=4
-expectedFooter="$DOCUMENT_ROOT/legal_notice.md $DOCUMENT_ROOT/accessibility.md $DOCUMENT_ROOT/data_protection_declaration.md"
+expectedFooter="\
+legal_notice.md \
+accessibility.md \
+data_protection_declaration.md"
 
-MSG=$(find ${DOCUMENT_ROOT} -name "*.md" | awk -F'/' '{print $0,NF}' | while IFS=' ' read string depth
+MSG=$(find ${DOCUMENT_ROOT} -name "*.md" | while IFS=' ' read string
   do
-    #echo "string=${string} depth=${depth}"
-
-    # max depth check 
-    if [ "${depth}" -gt $maxDepth ]; then
-      echo "max depth ($maxDepth) exceeded for ${string}"
-    fi
-
     md=${string#${DOCUMENT_ROOT}/}
 
     # md included in nav 
-    numberOfReferences=`sed -n '/nav:/,/^$/p' ${basedir}/mkdocs.yml | grep -c ${md}`
-    if [ $numberOfReferences -eq 0 ]; then
-      # fallback: md included in footer 
-      if [[ "${expectedFooter}" =~ ${string} ]]; then
-        numberOfReferencesInFooter=`sed -n '/footer:/,/^$/p' ${basedir}/mkdocs.yml | grep -c /${md%.md}`
-        if [ $numberOfReferencesInFooter -eq 0 ]; then
-          echo "${md} is not included in footer"
-        elif [ $numberOfReferencesInFooter -ne 1 ]; then
-          echo "${md} is included $numberOfReferencesInFooter times in footer"
-        fi
-      else
+    if [[ ! "${expectedFooter}" =~ ${md} ]]; then
+      numberOfReferences=$(sed -n '/nav:/,/^$/p' ${basedir}/mkdocs.yml \
+        | grep -c ${md})
+      if [[ ${numberOfReferences} -eq 0 ]]; then
         echo "${md} is not included in nav"
       fi
-    elif [ $numberOfReferences -ne 1 ]; then
-      echo "${md} is included $numberOfReferences times in nav"
     fi
   done
 )
-if [ ! -z "${MSG}" ]; then
+if [[ ! -z "${MSG}" ]]; then
   echo "${MSG}"
-  exit -1
+  exit 1
 fi

doc.zih.tu-dresden.de/util/pre-commit

@@ -54,6 +54,30 @@ while read -r; do
   fi
 done <<< "$files"
 
+echo "Checking floating pages"
+if ! runInDocker ./doc.zih.tu-dresden.de/util/check-no-floating.sh; then
+  echo -e "\tFailed"
+  exit_ok=no
+fi
+
+echo "Checking that every page is not included more than once"
+if ! runInDocker ./doc.zih.tu-dresden.de/util/check-every-page-not-included-more-than-once.sh; then
+  echo -e "\tFailed"
+  exit_ok=no
+fi
+
+echo "Checking that contains necessary links"
+if ! runInDocker ./doc.zih.tu-dresden.de/util/check-footer.sh; then
+  echo -e "\tFailed"
+  exit_ok=no
+fi
+
+echo "Checking max depth"
+if ! runInDocker ./doc.zih.tu-dresden.de/util/check-max-depth.sh; then
+  echo -e "\tFailed"
+  exit_ok=no
+fi
+
 echo "Testing syntax of bash files..."
 if ! runInDocker ./doc.zih.tu-dresden.de/util/check-bash-syntax.sh; then
   echo -e "\tFailed"