From 70f3d67327390df36f188e4b2110a6778d66ab1d Mon Sep 17 00:00:00 2001
From: Martin Schroschk <martin.schroschk@tu-dresden.de>
Date: Fri, 28 Jan 2022 09:06:43 +0100
Subject: [PATCH] Fix style and link

---
 .../docs/jobs_and_resources/slurm_profiling.md   | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/doc.zih.tu-dresden.de/docs/jobs_and_resources/slurm_profiling.md b/doc.zih.tu-dresden.de/docs/jobs_and_resources/slurm_profiling.md
index 5d10dae55..175333cb0 100644
--- a/doc.zih.tu-dresden.de/docs/jobs_and_resources/slurm_profiling.md
+++ b/doc.zih.tu-dresden.de/docs/jobs_and_resources/slurm_profiling.md
@@ -63,9 +63,8 @@ More information about profiling with Slurm:
 
 ## Memory Consumption of a Job
 
-If you are only interested in the maximal memory consumption of your job, you
-don't need profiling at all. This information can be retrieved from within 
-[batch files](slurm.md#batch_jobs) as follows:
+If you are only interested in the maximal memory consumption of your job, you don't need profiling
+at all. This information can be retrieved from within [job files](slurm.md#batch-jobs) as follows:
 
 ```bash
 #!/bin/bash
@@ -81,7 +80,7 @@ srun a.exe
 srun max_mem.sh
 ```
 
-The script max_mem.sh is:
+The script `max_mem.sh` is:
 
 ```bash
 #!/bin/bash
@@ -90,6 +89,9 @@ echo -n "$(hostname): "
 cat /sys/fs/cgroup/memory/slurm/uid_${SLURM_JOB_UID}/job_${SLURM_JOB_ID}/memory.max_usage_in_bytes
 ```
 
-**Remarks**:
-  * Make sure that `max_mem.sh` is executable (e.g., `chmod +x max_mem.sh`) and add the path to this script if it is not within the same directory.
-  * The `srun` command is necessary to gather the max. memory from all nodes within this job. Otherwise, you would only get the data from one node. 
+!!! note
+
+  * Make sure that the script `max_mem.sh` is executable (e.g., `chmod +x max_mem.sh`) and add the
+    path to this script if it is not within the same directory.
+  * The `srun` command is necessary to gather the max. memory from all nodes within this job.
+    Otherwise, you would only get the data from one node.
-- 
GitLab