From 47813831b557cb995c27877425eb4c1d4f2fe302 Mon Sep 17 00:00:00 2001 From: Jan Frenzel <jan.frenzel@tu-dresden.de> Date: Mon, 11 Oct 2021 11:29:45 +0200 Subject: [PATCH] Added pattern for links in grep-forbidden-words.sh and some description in README.md. Closes #185. --- doc.zih.tu-dresden.de/README.md | 2 ++ doc.zih.tu-dresden.de/util/grep-forbidden-words.sh | 1 + 2 files changed, 3 insertions(+) diff --git a/doc.zih.tu-dresden.de/README.md b/doc.zih.tu-dresden.de/README.md index 1829a5bc5..e7de9cd2e 100644 --- a/doc.zih.tu-dresden.de/README.md +++ b/doc.zih.tu-dresden.de/README.md @@ -465,6 +465,8 @@ should be highlighted, etc. Code examples, longer than half screen height should **TODO** Guide [Issue #14](#14) * 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) ### Spelling and Technical Wording diff --git a/doc.zih.tu-dresden.de/util/grep-forbidden-words.sh b/doc.zih.tu-dresden.de/util/grep-forbidden-words.sh index 456eb55e1..1a9fa3d37 100755 --- a/doc.zih.tu-dresden.de/util/grep-forbidden-words.sh +++ b/doc.zih.tu-dresden.de/util/grep-forbidden-words.sh @@ -19,6 +19,7 @@ i \<taurus\> taurus\.hrsk /taurus /TAURUS i \<hrskii\> i hpc[ -]\+da\> i \(alpha\|ml\|haswell\|romeo\|gpu\|smp\|julia\|hpdlf\|scs5\)-\?\(interactive\)\?[^a-z]*partition +i \[\s\?\(documentation\|here\|this \(link\|page\|subsection\)\|slides\?\|manpage\)\s\?\] i work[ -]\+space" # Whitelisted files will be ignored -- GitLab