From 2a2284690cb102226e0404240881e2ae6ee228b3 Mon Sep 17 00:00:00 2001 From: Mirjam Aulbach Date: Tue, 26 Sep 2023 10:34:15 +0200 Subject: [PATCH] Name docs files better. Signed-off-by: Mirjam Aulbach --- .github/vale/vale.md | 2 +- markdown-link-check-script/markdown-link-check.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/vale/vale.md b/.github/vale/vale.md index af1aa01a..c64250c6 100644 --- a/.github/vale/vale.md +++ b/.github/vale/vale.md @@ -38,7 +38,7 @@ When you have Vale installed, you can run this scripts on root level: - what files to check (`.md` and `.mdx` files) - what styles to use ([Google package](https://vale.sh/hub/google/) as well as custom Klaw styles) -The GitHub workflow is defined in [`.github/workflows/vale.yaml`](/.github/workflows/vale.yaml) +The GitHub workflow is defined in [`.github/workflows/vale.yaml`](../workflows/vale.yaml) ### Spell checking diff --git a/markdown-link-check-script/markdown-link-check.md b/markdown-link-check-script/markdown-link-check.md index c938b54d..6e447131 100644 --- a/markdown-link-check-script/markdown-link-check.md +++ b/markdown-link-check-script/markdown-link-check.md @@ -11,7 +11,7 @@ order to use them. ### ➡️ `npm run markdown-link-check` Will run the check for all Markdown files. It checks internal as well as external links (so it needs internet -connection) and assets. Please be aware that you need to [check your results](#-limitation) +connection) and assets. Please be aware that you need to [check your results](#limitation) ### ➡️ `npm run markdown-link-check -f "path/to/file.md` @@ -27,9 +27,9 @@ connection) and assets. The flags can be used with all files as well as only one. They can also be used together. -## ⚠️ Limitation +## Limitation -When running the link-check for all files without the offline mode flag, the first command ("Checking links in all +⚠️ When running the link-check for all files without the offline mode flag, the first command ("Checking links in all markdown files in /docs") will always return an exist code `1`. We've investigated that for quite some time, but not found out what the issue is. Since we're only using offline mode in CI, we decided that we can live with that for now, as we still can run the checks and get all result.