Merge pull request #5 from richelbilderbeek/master

Add actual material

Author: richelbilderbeek

.github/workflows/ci.yml

@@ -1,8 +1,11 @@
 name: ci
+
 on:
   push:
-    branches:
-      - master
+  pull_request:
+  schedule:
+  - cron: "0 0 1 * *"
+
 jobs:
   deploy:
     runs-on: ubuntu-latest

.spellcheck.yml

@@ -19,27 +19,5 @@ matrix:
       - 'pre'
       - 'blockquote'
   sources:
-  - '**/*.md'
-  default_encoding: utf-8
-- name: Quarto markdown
-  dictionary:
-    wordlists:
-    - .wordlist.txt
-    output: wordlist.dic
-    encoding: utf-8
-  pipeline:
-  - pyspelling.filters.markdown:
-      markdown_extensions:
-      - markdown.extensions.extra:
-  - pyspelling.filters.html:
-      comments: false
-      attributes:
-      - alt
-      ignores:
-      - ':matches(code, pre)'
-      - 'code'
-      - 'pre'
-      - 'blockquote'
-  sources:
-  - '**/*.md'
+  - 'docs/**/*.md'
   default_encoding: utf-8

README.md

@@ -4,11 +4,11 @@ This is the GitHub repository of the UPPMAX AWK course.
 
 A nicely-rendered website of this repo is at <https://richelbilderbeek.github.io/awk_course/>.
 
-## Files used for continuous integration scripts
+## Files used by continuous integration scripts
 
 Filename                           |Descriptions
 -----------------------------------|------------------------------------------------------------------------------------------------------
-[mlc_config.json](mlc_config.json) |Configuration of the link checker
+[mlc_config.json](mlc_config.json) |Configuration of the link checker, use `markdown-link-check --config mlc_config.json --quiet docs/**/*.md` to do link checking locally
 [.spellcheck.yml](.spellcheck.yml) |Configuration of the spell checker, use `pyspelling -c .spellcheck.yml` to do spellcheck locally
 [.wordlist.txt](.wordlist.txt)     |Whitelisted words for the spell checker, use `pyspelling -c .spellcheck.yml` to do spellcheck locally
 

docs/afternoon_session/overview.md

@@ -19,6 +19,10 @@ Time          | Topic
 15:00-16:00   | Break
 15:15-16:00   | [Related tools](related_tools.md)
 
+> The times in this schedules are only guidelines.
+> The pace of the learners determines the speed of
+> going through the course material.
+
 Extra material:
 
 - [Built-in functions](https://learnbyexample.github.io/learn_gnuawk/built-in-functions.html)

docs/morning_session/overview.md

@@ -10,7 +10,11 @@ Time          | Topic
 10:00-10:15   | Break
 10:15-11:00   | [BEGIN and END](begin_and_end.md), [variables](variables.md)
 11:00-11:15   | Break
-11:15-12:00   | [Associative arrays](associative_arrays.md), [working with comma-separated values](working_with_csvs.md)
+11:15-12:00   | [working with comma-separated values](working_with_csvs.md), [Associative arrays](associative_arrays.md)
+
+> The times in this schedules are only guidelines.
+> The pace of the learners determines the speed of
+> going through the course material.
 
 ## Overview
 
@@ -34,6 +38,16 @@ flowchart TD
   filtering_on_regex --> |needs| filtering_on_values
 ```
 
+
+Description              |Syntax
+-------------------------|---------------------
+Do an action             |`{ [action] }`
+Filtering                |`[condition] { [action] }`
+Multiple filters         |`[condition_1] { [action_1] } [condition_2] { [action_2] }`
+Actions at begin and end |`BEGIN { [action]} [condition] { [action] } END { [action]}`
+
+> Overview of the Awk syntax built-up
+
 ## Links
 
  * [CLI text processing with GNU awk](https://learnbyexample.github.io/learn_gnuawk/)