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

Automated merge from preview to main

See merge request !590

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

@@ -7,22 +7,56 @@
 
 ## Login Nodes
 
-| Host                      | Fingerprint           |
-|:--------------------------|:----------------------|
-| `tauruslogin3.hrsk.tu-dresden.de` | SHA256:/M1lW1KTOlxj8UFZJS4tLi+8TyndcDqrZfLGX7KAU8s (RSA)      |
-| `tauruslogin4.hrsk.tu-dresden.de` | SHA256:PeCpW/gAFLvHDzTP2Rb93NxD+rpUsyQY8WebjQC7kz0 (ECDSA)    |
-| `tauruslogin5.hrsk.tu-dresden.de` | SHA256:nNxjtCny1kB0N0epHaOPeY1YFd0ri2Dvt2CK7rOGlXg (ED25519)  |
-| `tauruslogin6.hrsk.tu-dresden.de` | or: MD5:b8:e1:21:ed:38:1a:ba:1a:5b:2b:bc:35:31:62:21:49 (RSA) |
-| `taurus.hrsk.tu-dresden.de`      | MD5:47:7e:24:46:ab:30:59:2c:1f:e8:fd:37:2a:5d:ee:25 (ECDSA)   |
-|                                 | MD5:7c:0c:2b:8b:83:21:b2:08:19:93:6d:03:80:76:8a:7b (ED25519) |
+The following hostnames can be used to access ZIH systems:
+
+- `taurus.hrsk.tu-dresden.de`
+- `tauruslogin3.hrsk.tu-dresden.de`
+- `tauruslogin4.hrsk.tu-dresden.de`
+- `tauruslogin5.hrsk.tu-dresden.de`
+- `tauruslogin6.hrsk.tu-dresden.de`
+
+All of these login nodes share common keys. When connecting, please make sure that the fingerprint
+shown matches one of the table.
+
+| Key type | Fingerprint                                         |
+|:---------|:----------------------------------------------------|
+| RSA      | SHA256:/M1lW1KTOlxj8UFZJS4tLi+8TyndcDqrZfLGX7KAU8s  |
+| RSA      | MD5:b8:e1:21:ed:38:1a:ba:1a:5b:2b:bc:35:31:62:21:49 |
+| ECDSA    | SHA256:PeCpW/gAFLvHDzTP2Rb93NxD+rpUsyQY8WebjQC7kz0  |
+| ECDSA    | MD5:47:7e:24:46:ab:30:59:2c:1f:e8:fd:37:2a:5d:ee:25 |
+| ED25519  | SHA256:nNxjtCny1kB0N0epHaOPeY1YFd0ri2Dvt2CK7rOGlXg  |
+| ED25519  | MD5:7c:0c:2b:8b:83:21:b2:08:19:93:6d:03:80:76:8a:7b |
+{: summary="List of valid fingerprints for login nodes"}
+
+??? example "Connecting with SSH"
+
+    ```console
+    marie@local$ ssh taurus.hrsk.tu-dresden.de
+    The authenticity of host 'taurus.hrsk.tu-dresden.de (141.30.73.105)' can't be established.
+    ECDSA key fingerprint is SHA256:PeCpW/gAFLvHDzTP2Rb93NxD+rpUsyQY8WebjQC7kz0.
+    Are you sure you want to continue connecting (yes/no)?
+    ```
+
+    In this case, the fingerprint matches the one given in the table. Thus, one can proceed by
+    typing 'yes'.
 
 ## Export Nodes
 
-| Host                      | Fingerprint           |
-|:--------------------------|:----------------------|
-| `taurusexport.hrsk.tu-dresden.de`  | SHA256:Qjg79R+5x8jlyHhLBZYht599vRk+SujnG1yT1l2dYUM (RSA)   |
-| `taurusexport3.hrsk.tu-dresden.de` | SHA256:qXTZnZMvdqTs3LziA12T1wkhNcFqTHe59fbbU67Qw3g (ECDSA) |
-| `taurusexport4.hrsk.tu-dresden.de` | SHA256:jxWiddvDe0E6kpH55PHKF0AaBg/dQLefQaQZ2P4mb3o (ED25519)  |
-|                                    | or: MD5:1e:4c:2d:81:ee:58:1b:d1:3c:0a:18:c4:f7:0b:23:20 (RSA) |
-|                                    | MD5:96:62:c6:80:a8:1f:34:64:86:f3:cf:c5:9b:cd:af:da (ECDSA)   |
-|                                    | MD5:fe:0a:d2:46:10:4a:08:40:fd:e1:99:b7:f2:06:4f:bc (ED25519) |
+The following hostnames can be used to transfer files to/from ZIH systems:
+
+- `taurusexport.hrsk.tu-dresden.de`
+- `taurusexport3.hrsk.tu-dresden.de`
+- `taurusexport4.hrsk.tu-dresden.de`
+
+All of these export nodes share common keys. When transfering files, please make sure that the
+fingerprint shown matches one of the table.
+
+| Key type | Fingerprint                                         |
+|:---------|:----------------------------------------------------|
+| RSA      | SHA256:Qjg79R+5x8jlyHhLBZYht599vRk+SujnG1yT1l2dYUM  |
+| RSA      | MD5:1e:4c:2d:81:ee:58:1b:d1:3c:0a:18:c4:f7:0b:23:20 |
+| ECDSA    | SHA256:qXTZnZMvdqTs3LziA12T1wkhNcFqTHe59fbbU67Qw3g  |
+| ECDSA    | MD5:96:62:c6:80:a8:1f:34:64:86:f3:cf:c5:9b:cd:af:da |
+| ED25519  | SHA256:jxWiddvDe0E6kpH55PHKF0AaBg/dQLefQaQZ2P4mb3o  |
+| ED25519  | MD5:fe:0a:d2:46:10:4a:08:40:fd:e1:99:b7:f2:06:4f:bc |
+{: summary="List of valid fingerprints for export nodes"}

doc.zih.tu-dresden.de/docs/software/scs5_software.md → doc.zih.tu-dresden.de/docs/archive/scs5_software.md

 # SCS5 Migration Hints
 
+!!! warning
+
+    This page is outdated!
+
 Bull's new cluster software is called SCS 5 (*Super Computing Suite*).
 Here are the major changes from the user's perspective:
 
@@ -22,7 +26,8 @@ remove it and accept the new one after comparing its fingerprint with those list
 
 Starting with SCS5, we do not support [C environment modules](http://modules.sourceforge.net/)
 anymore. We only provide [Lmod](http://lmod.readthedocs.io/en/latest/index.html) as the environment
-module tool of choice. Refer to the [module page](modules.md) for further information on modules.
+module tool of choice. Refer to the [module page](../software/modules.md) for further information on
+modules.
 
 As usual, you can get a list of the available software modules via:
 

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

@@ -77,14 +77,22 @@ should be highlighted, etc. Code examples, longer than half screen height should
 
 ## Writing Style
 
-* Avoid using tabs both in markdown files and in `mkdocs.yaml`. Type spaces instead.
-* Capitalize headings, e.g. *Exclusive Reservation of Hardware*
-* Give keywords in link texts, e.g. [Code Blocks](#code-blocks-and-syntax-highlighting) is more
-  descriptive than [this subsection](#code-blocks-and-syntax-highlighting)
+* Assume that a future reader is eager to start typing commands. Thus, encourage the reader by
+  addressing him/her directly:
+    * Example: Use `You can/should ...` instead of `Users can/should ...`
+    * Example: Use `Your contribution is highly welcome` instead of `Contributions from user-side
+      are highly welcome`
+* Be brief! Provide the main idea/commands first, special cases later. If it is not necessary to
+  know how a special piece of software works, don't explain it.
+* Provide the often-used commands first.
 * Use active over passive voice
     * Write with confidence. This confidence should be reflected in the documentation, so that
       the readers trust and follow it.
     * Example: `We recommend something` instead of `Something is recommended.`
+* Capitalize headings, e.g. *Exclusive Reservation of Hardware*
+* Give keywords in link texts, e.g. [Code Blocks](#code-blocks-and-syntax-highlighting) is more
+  descriptive than [this subsection](#code-blocks-and-syntax-highlighting)
+* Avoid using tabs both in markdown files and in `mkdocs.yaml`. Type spaces instead.
 
 ## Spelling and Technical Wording
 
@@ -258,8 +266,8 @@ _Result_:
 
 ### Data Privacy and Generic Names
 
-Where possible, replace login, project name and other private data with clearly arbitrary
-placeholders.  In particular, use the generic login `marie` and the project title `p_number_crunch`
+Where possible, replace login, project name and other private data with clearly recognizable
+placeholders. In particular, use the generic login `marie` and the project title `p_number_crunch`
 as placeholders.
 
 ```console
@@ -269,15 +277,26 @@ drwxr-xr-x   3 marie p_number_crunch      4096 Feb 12  2020 data
 -rw-rw----   1 marie p_number_crunch      4096 Jan 24  2020 readme.md
 ```
 
-### Placeholders
+#### Placeholders
+
+Placeholders represent arguments or code parts that can be adapted to the user's needs. Use them to
+give a general idea of how a command or code snippet can be used, e. g. to explain the meaning of
+some command argument:
 
-TODO!
+```bash
+marie@login$ sacct -j <job id>
+```
 
-## Mark Omissions
+Here, a placeholder explains the intention better than just a specific value:
 
-If showing only a snippet of a long output, omissions are marked with `[...]`.
+```console
+marie@login$ sacct -j 4041337
+```
 
-## Unix Rules
+Please be aware, that a reader often understands placeholders easier if you also give an example.
+Therefore, always add an example!
+
+##### Unix Rules
 
 Stick to the Unix rules on optional and required arguments, and selection of item sets:
 
@@ -285,6 +304,10 @@ Stick to the Unix rules on optional and required arguments, and selection of ite
 * `[optional argument or value]`
 * `{choice1|choice2|choice3}`
 
+#### Mark Omissions
+
+If showing only a snippet of a long output, omissions are marked with `[...]`.
+
 ## Graphics and Attachments
 
 All graphics and attachments are saved within `misc` directory of the respective sub directory in

doc.zih.tu-dresden.de/docs/index.md

 # ZIH HPC Documentation
 
 This is the documentation of the HPC systems and services provided at
-[TU Dresden/ZIH](https://tu-dresden.de/zih/).  This documentation is work in progress, since we try
+[TU Dresden/ZIH](https://tu-dresden.de/zih/). This documentation is work in progress, since we try
 to incorporate more information with increasing experience and with every question you ask us. The
 HPC team invites you to take part in the improvement of these pages by correcting or adding useful
 information.
@@ -13,7 +13,7 @@ Issues concerning this documentation can reported via the GitLab
 Please check for any already existing issue before submitting your issue in order to avoid duplicate
 issues.
 
-Contributions from user-side are highly welcome. Please find out more in our [guidelines how to contribute](contrib/howto_contribute.md).
+Your contributions are highly welcome. Please find out more in our [guidelines how to contribute](contrib/howto_contribute.md).
 
 !!! tip "Reminder"
 

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

@@ -34,7 +34,7 @@ marie@login$ # source $FOAM_CSH
     #SBATCH --time=12:00:00     # walltime
     #SBATCH --ntasks=60         # number of processor cores (i.e. tasks)
     #SBATCH --mem-per-cpu=500M  # memory per CPU core
-    #SBATCH -job-name="Test"    # job name
+    #SBATCH --job-name="Test"   # job name
     #SBATCH --mail-user=marie@tu-dresden.de  # email address (only tu-dresden)
     #SBATCH --mail-type=ALL
 
@@ -75,6 +75,7 @@ geometry and mesh generator cfx5pre, and the post-processor cfx5post.
     #SBATCH --mem-per-cpu=1900M                 # memory per CPU core
     #SBATCH --mail-user=marie@tu-dresden.de     # email address (only tu-dresden)
     #SBATCH --mail-type=ALL
+
     module load ANSYS
 
     nodeset -e $SLURM_JOB_NODELIST | xargs -n1 > hostsfile_job_$SLURM_JOBID.txt

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

@@ -58,7 +58,6 @@ nav:
       - Distributed Training: software/distributed_training.md
       - Hyperparameter Optimization (OmniOpt): software/hyperparameter_optimization.md
       - Machine Learning with PowerAI: software/power_ai.md
-    - SCS5 Migration Hints: software/scs5_software.md
     - Virtual Desktops: software/virtual_desktops.md
     - Software Development and Tools:
       - Overview: software/software_development_overview.md
@@ -125,6 +124,7 @@ nav:
       - System Triton: archive/system_triton.md
       - System Venus: archive/system_venus.md
       - KNL Nodes: archive/knl_nodes.md
+    - SCS5 Migration Hints: archive/scs5_software.md
     - UNICORE Rest API: archive/unicore_rest_api.md
     - VampirTrace: archive/vampirtrace.md
     - Windows Batchjobs: archive/windows_batch.md