Merge pull request #944 from aramase/fix-md-link-check

ci: fix markdown link check workflow failures

.github/workflows/markdown-link-check.yaml

@@ -2,11 +2,15 @@ name: Check Markdown links
 
 on:
   push:
+    paths:
+      - "**.md"
     branches:
     - main
   pull_request:
     branches:
     - main
+    paths: 
+    - "**.md"
   schedule:
     - cron: "0 9 * * *"
 
@@ -25,3 +29,4 @@ jobs:
         use-quiet-mode: 'yes'
         # this will show detailed HTTP status for checked links
         use-verbose-mode: 'yes'
+        config-file: .markdownlinkcheck.json

.markdownlinkcheck.json

@@ -0,0 +1,22 @@
+{
+    "httpHeaders": [
+        {
+            "comment": "Workaround as suggested here: https://github.com/tcort/markdown-link-check/issues/201",
+            "urls": [
+                "https://docs.github.com/"
+            ],
+            "headers": {
+                "Accept-Encoding": "zstd, br, gzip, deflate"
+            }
+        }
+    ],
+    "timeout": "5s",
+    "retryOn429": true,
+    "retryCount": 5,
+    "fallbackRetryDelay": "30s",
+    "aliveStatusCodes": [
+        200,
+        206
+    ]
+}
+

docs/book/src/SUMMARY.md

@@ -18,5 +18,5 @@
 - [Load tests](./load-tests.md)
 - [Testing](./testing.md)
 - [Known Limitations](./known-limitations.md)
-- [Release Managment](./release-management.md)
+- [Release Management](./release-management.md)
 - [Design docs](./design-docs.md)