Fix markdown

UPPMAX · Aug 15, 2024 · ef53809 · ef53809
1 parent 3d207a4
commit ef53809
Show file tree

Hide file tree

Showing 13 changed files with 207 additions and 64 deletions.
diff --git a/.github/workflows/check_markdown.yaml b/.github/workflows/check_markdown.yaml
@@ -20,8 +20,17 @@ jobs:
       - name: Set up Git repository
         uses: actions/checkout@v4
 
+      # There are many linters with the same name,
+      # this is the linter whose documentation to look into :-)
+      - name: CLI to the linter is at https://github.com/igorshubovych/markdownlint-cli
+        run: echo "CLI to the linter is at https://github.com/igorshubovych/markdownlint-cli"
+
+      # There are many linters with the same name,
+      # this is the linter whose documentation to look into :-)
+      - name: Linter is at https://github.com/DavidAnson/markdownlint
+        run: echo "Linter is at https://github.com/DavidAnson/markdownlint"
+
       - uses: articulate/actions-markdownlint@v1
         with:
           config: .markdownlint.jsonc
           ignore: .markdownlintignore
-
diff --git a/docs/overviews/schedule.md b/docs/overviews/schedule.md
@@ -1,5 +1,8 @@
 # Schedule
 
+<!-- Indeed, line lengths beyond 80 characters -->
+<!-- markdownlint-disable MD013 -->
+
 When       |Who|What
 -----------|---|-----------------
 09:00-09:15|R  |Introduction
@@ -15,3 +18,5 @@ When       |Who|What
 15:00-15:15|.  |Break
 15:15-15:45|R  |[Doing real work](../sessions/introduction_real_work.md) 2/2
 15:45-16:00|R  |[Evaluation](../misc/evaluation.md)
+
+<!-- markdownlint-enable MD013 -->
diff --git a/docs/overviews/uppmax_intro_day_1.md b/docs/overviews/uppmax_intro_day_1.md
@@ -1,5 +1,8 @@
 # UPPMAX Intro Day 1
 
+<!-- Indeed, line lengths beyond 80 characters -->
+<!-- markdownlint-disable MD013 -->
+
 ```mermaid
 flowchart TD
 
@@ -186,3 +189,4 @@ flowchart TD
   interactive --> use_ide
 ```
 
+<!-- markdownlint-enable MD013 -->
diff --git a/docs/sessions/introduction_visual.md b/docs/sessions/introduction_visual.md
@@ -8,6 +8,9 @@ before moving to more abstract new topics.
 We will not yet discuss IDEs (whatever those are) yet,
 as it requires using techniques we teach later.
 
+<!-- Indeed, line lengths beyond 80 characters -->
+<!-- markdownlint-disable MD013 -->
+
 ```mermaid
 flowchart TD
   classDef not_yet_node stroke-dasharray: 5 5
@@ -31,3 +34,5 @@ Link                                                                          |D
 [Log in to remote desktop environment](../sessions/login_remote_desktop.md)   |Log in to the Rackham remote desktop environment via the website
 [Using the remote desktop environment](../sessions/use_remote_desktop.md)     |Using a remote desktop environment
 [File transfer using FileZilla](../sessions/file_transfer_using_filezilla.md) |File transfer using FileZilla
+
+<!-- markdownlint-enable MD013 -->
diff --git a/docs/sessions/job_scheduler.md b/docs/sessions/job_scheduler.md
@@ -74,7 +74,8 @@ flowchart TD
 
 ### Exercise 1: see the job queue
 
-Go to the UPPMAX documentation at [https://docs.uppmax.uu.se](https://docs.uppmax.uu.se),
+Go to the UPPMAX documentation at
+[https://docs.uppmax.uu.se](https://docs.uppmax.uu.se),
 then answer these questions:
 
 - Find the page on `squeue`, the program to view the job queue
@@ -107,7 +108,8 @@ then answer these questions:
 
 ### Exercise 2: view my UPPMAX projects
 
-Go to the UPPMAX documentation at [https://docs.uppmax.uu.se](https://docs.uppmax.uu.se),
+Go to the UPPMAX documentation at
+[https://docs.uppmax.uu.se](https://docs.uppmax.uu.se),
 then answer these questions:
 
 - Find the UPPMAX documentation page about projects
@@ -140,7 +142,8 @@ then answer these questions:
 
 ### Exercise 3: submit a minimal job with Slurm parameters in the command-line
 
-Go to the UPPMAX documentation at [https://docs.uppmax.uu.se](https://docs.uppmax.uu.se),
+Go to the UPPMAX documentation at
+[https://docs.uppmax.uu.se](https://docs.uppmax.uu.se),
 then answer these questions:
 
 - Create a minimal bash script that does something.
@@ -200,13 +203,18 @@ then answer these questions:
 
     Will result in the following error:
 
+    <!-- Indeed, line lengths beyond 80 characters -->
+    <!-- markdownlint-disable MD013 -->
+
     ```bash
     [sven@rackham3 ~]$ sbatch -A naiss2024-22-49 my_script.sh
     sbatch: error: This does not look like a batch script.  The first
     sbatch: error: line must start with #! followed by the path to an interpreter.
     sbatch: error: For instance: #!/bin/sh
     ```
 
+    <!-- markdownlint-enable MD013 -->
+
 - Use `squeue` to confirm that your job is in the job queue.
   You may need to be fast to see it!
 
@@ -227,17 +235,23 @@ then answer these questions:
 
     The output will be similar to:
 
+    <!-- Indeed, line lengths beyond 80 characters -->
+    <!-- markdownlint-disable MD013 -->
+
     ```bash
     [richel@rackham3 ~]$ sbatch -A naiss2024-22-49 my_script.sh; squeue -u $USER
     Submitted batch job 49309860
                  JOBID PARTITION     NAME     USER ST       TIME  NODES NODELIST(REASON)
               49309860      core my_scrip   richel PD       0:00      1 (None)
     ```
 
+    <!-- markdownlint-enable MD013 -->
+
 
 ### Exercise 4: submit a minimal job with Slurm parameters in the bash script
 
-Go to the UPPMAX documentation at [https://docs.uppmax.uu.se](https://docs.uppmax.uu.se),
+Go to the UPPMAX documentation at
+[https://docs.uppmax.uu.se](https://docs.uppmax.uu.se),
 then answer these questions:
 
 - Find the page on `sbatch` again
@@ -263,7 +277,8 @@ then answer these questions:
 
 ### Exercise 5: cancel a job
 
-Go to the UPPMAX documentation at [https://docs.uppmax.uu.se](https://docs.uppmax.uu.se),
+Go to the UPPMAX documentation at
+[https://docs.uppmax.uu.se](https://docs.uppmax.uu.se),
 then answer these questions:
 
 - Find the page on `scancel`
@@ -285,8 +300,10 @@ then answer these questions:
     [sven@rackham3 ~]$ 
     ```
 
-- (optional) Schedule a job that takes 1 days, 2 hours, 3 minutes and 4 seconds and cancel it.
-  Use [the Slurm documentation on `sbatch`](https://slurm.schedmd.com/sbatch.html)
+- (optional) Schedule a job that takes 1 days, 2 hours, 3 minutes and 4
+  seconds and cancel it.
+  Use
+  [the Slurm documentation on `sbatch`](https://slurm.schedmd.com/sbatch.html)
 
 ???- question "Answer"
 

diff --git a/docs/sessions/login.md b/docs/sessions/login.md
@@ -66,9 +66,14 @@ After logging in, one wants to behave considerate towards other users.
 
 ## Prerequisites
 
+<!-- Indeed, line lengths beyond 80 characters -->
+<!-- markdownlint-disable MD013 -->
+
 It is assumed you have fulfilled all
 [prerequisites for using Rackham](https://docs.uppmax.uu.se/getting_started/rackham_usage_prerequisites/).
 
+<!-- markdownlint-enable MD013 -->
+
 ## Introduction
 
 In this session, we warm up for using the UPPMAX HPC cluster
@@ -83,7 +88,8 @@ Also, it helps UPPMAX staff find out how good our documentation is :-)
 
 ### Exercise 1: general understanding
 
-Go to the UPPMAX documentation at [https://docs.uppmax.uu.se](https://docs.uppmax.uu.se),
+Go to the UPPMAX documentation at
+[https://docs.uppmax.uu.se](https://docs.uppmax.uu.se),
 then answer these questions:
 
 - Where is it is described how to log in to Rackham?
@@ -92,7 +98,8 @@ then answer these questions:
 
     It is at <https://docs.uppmax.uu.se/getting_started/login_rackham/>.
 
-    You can reach this page by searching for 'Login Rackham' or 'Log in Rackham'. 
+    You can reach this page by searching for 
+    'Login Rackham' or 'Log in Rackham'. 
 
 - How many environments can one log in to? How do they look like?
 
@@ -105,9 +112,11 @@ then answer these questions:
 
     - a console environment, which looks like text. No graphics. Text.
 
-    These answers can be found at <https://docs.uppmax.uu.se/getting_started/login_rackham/>.
+    These answers can be found at
+    <https://docs.uppmax.uu.se/getting_started/login_rackham/>.
 
-- The documentation of how to log in to Rackham states: 'After logging in, one is on a login node'.
+- The documentation of how to log in to Rackham states:
+  'After logging in, one is on a login node'.
   Where it is described what a login node?
 
 ???- question "Answer"
@@ -175,6 +184,12 @@ then answer these questions:
 
 Done?
 
+<!-- Indeed, line lengths beyond 80 characters -->
+<!-- markdownlint-disable MD013 -->
+
 - If you want to know what an HPC cluster is in more detail,
-  read up on [the UPPMAX clusters](https://docs.uppmax.uu.se/cluster_guides/uppmax_cluster/)
+  read up on
+  [the UPPMAX clusters](https://docs.uppmax.uu.se/cluster_guides/uppmax_cluster/)
 - Else move on to the next session
+
+<!-- markdownlint-enable MD013 -->
diff --git a/docs/sessions/login_console.md b/docs/sessions/login_console.md
@@ -23,7 +23,8 @@
     - Learners understand that after login, one is on a login node
     - If needed, learners have installed an SSH client
         - Windows: MobaXTerm
-    - Learners have logged in to the console environment using a terminal with X forwarding
+    - Learners have logged in to the console environment
+      using a terminal with X forwarding
     - Learners have determined if X forwarding works
 
     Lesson plan:
@@ -75,7 +76,8 @@ For Mac and Windows users it will be hardest to get it working.
 
 ### Exercise 1: a terminal
 
-Go to the UPPMAX documentation at [https://docs.uppmax.uu.se](https://docs.uppmax.uu.se),
+Go to the UPPMAX documentation at
+[https://docs.uppmax.uu.se](https://docs.uppmax.uu.se),
 then answer these questions:
 
 - Find the UPPMAX page on terminals
@@ -93,7 +95,8 @@ then answer these questions:
 
 ### Exercise 2: install an SSH client if needed
 
-Go to the UPPMAX documentation at [https://docs.uppmax.uu.se](https://docs.uppmax.uu.se),
+Go to the UPPMAX documentation at
+[https://docs.uppmax.uu.se](https://docs.uppmax.uu.se),
 then answer these questions:
 
 - Find the UPPMAX page on SSH clients
@@ -126,21 +129,26 @@ then answer these questions:
 
 ### Exercise 3: login via SSH
 
-Go to the UPPMAX documentation at [https://docs.uppmax.uu.se](https://docs.uppmax.uu.se),
+Go to the UPPMAX documentation at
+[https://docs.uppmax.uu.se](https://docs.uppmax.uu.se),
 then answer these questions:
 
 - Find the page about how to login to Rackham via SSH and a password
 
 ???- question "I cannot find it. Where is it?"
 
-    You can find find it at <https://docs.uppmax.uu.se/getting_started/login_rackham_console_password/>
+    You can find find it at
+    <https://docs.uppmax.uu.se/getting_started/login_rackham_console_password/>
 
 - Log in to Rackham
 
 ???- question "How does that look like?"
 
     Your ouput will look similar to this:
 
+    <!-- Indeed, line lengths beyond 80 characters -->
+    <!-- markdownlint-disable MD013 -->
+
     ```bash
     sven@richel-N141CU:~/GitHubs/uppmax_intro_day_1/docs/sessions$ ssh -X sven@rackham.uppmax.uu.se
     sven@rackham.uppmax.uu.se's password: 
@@ -161,6 +169,9 @@ then answer these questions:
     [sven@rackham1 ~]$ 
     ```
 
+    <!-- markdownlint-enable MD013 -->
+
+
 Welcome on a login node!
 
 ### Exercise 4: find out if X forwarding works

diff --git a/docs/sessions/login_remote_desktop.md b/docs/sessions/login_remote_desktop.md
@@ -14,7 +14,8 @@ tags:
 
     - Practice using the UPPMAX documentation
     - Can log in to the Rackham remote desktop environment using the website
-    - (optional) Can log in to the Rackham remote desktop environment using a local ThinLinc client
+    - (optional) Can log in to the Rackham remote desktop environment
+      using a local ThinLinc client
 
 ???- question "For teachers"
 
@@ -87,34 +88,49 @@ There are two exercises, of which the second is optional.
 
 ### Exercise 1: login via website
 
-Go to the UPPMAX documentation at [https://docs.uppmax.uu.se](https://docs.uppmax.uu.se),
+Go to the UPPMAX documentation at
+[https://docs.uppmax.uu.se](https://docs.uppmax.uu.se),
 then answer these questions:
 
-- Find the page where it is documented to log in to Rackham's remote desktop via a webbrowser.
+- Find the page where it is documented to log in to Rackham's remote desktop
+  via a webbrowser.
 
 ???- question "Answer"
 
+    <!-- Indeed, line lengths beyond 80 characters -->
+    <!-- markdownlint-disable MD013 -->
+
     The page is [here](http://docs.uppmax.uu.se/getting_started/login_rackham_remote_desktop_website/).
 
+    <!-- markdownlint-enable MD013 -->
+
 - Follow the procedure
 
 ### (optional) Exercise 2: login via a program
 
-Go to the UPPMAX documentation at [https://docs.uppmax.uu.se](https://docs.uppmax.uu.se),
+Go to the UPPMAX documentation at
+[https://docs.uppmax.uu.se](https://docs.uppmax.uu.se),
 then answer these questions:
 
 - Find the page where it is documented to log in to Rackham's remote desktop using
   a program. What is that program called?
 
 ???- question "Answer"
 
+    <!-- Indeed, line lengths beyond 80 characters -->
+    <!-- markdownlint-disable MD013 -->
+
     It is hard to search for which program that is. However,
-    using the ['log in to Rackham' page](https://docs.uppmax.uu.se/getting_started/login_rackham/)
+    using the
+    ['log in to Rackham' page](https://docs.uppmax.uu.se/getting_started/login_rackham/)
     shows the login via 'a local ThinLinc client'.
 
     That is the program's name: ThinLinc
 
     How to log in to Rackham's remote desktop environment using a local ThinLinc 
-    client is documented [here](http://docs.uppmax.uu.se/getting_started/login_rackham_remote_desktop_local_thinlinc_client/)
+    client is documented
+    [here](http://docs.uppmax.uu.se/getting_started/login_rackham_remote_desktop_local_thinlinc_client/)
+
+    <!-- markdownlint-enable MD013 -->
 
 - Follow the procedure