From 67c9a02329a1ebdef2899e5147c419ad5ca9dd9f Mon Sep 17 00:00:00 2001
From: Xuan <112967240+xuan-cao-swi@users.noreply.github.com>
Date: Mon, 6 Jan 2025 11:54:13 -0500
Subject: [PATCH] docs: update action for link check and fix one broken link
 (#1322)

fix: update action for link check and fix one broken link
---
 .github/workflows/ci-markdown-link.yml             | 13 ++++++++-----
 .markdown-link-check.json                          | 10 ----------
 instrumentation/active_model_serializers/README.md |  2 +-
 3 files changed, 9 insertions(+), 16 deletions(-)
 delete mode 100644 .markdown-link-check.json

diff --git a/.github/workflows/ci-markdown-link.yml b/.github/workflows/ci-markdown-link.yml
index 7b42be0c1..626a8fce4 100644
--- a/.github/workflows/ci-markdown-link.yml
+++ b/.github/workflows/ci-markdown-link.yml
@@ -2,6 +2,8 @@ name: Markdown Link Check
 
 on:
   pull_request:
+    paths:
+      - '**/*.md'
 
 jobs:
   markdown-link-check:
@@ -9,9 +11,10 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: "Markdown Link Check"
-        uses: gaurav-nelson/github-action-markdown-link-check@v1
+      # equivalent cli: linkspector check
+      - name: Run linkspector
+        uses: umbrelladocs/action-linkspector@v1
         with:
-          config-file: '.markdown-link-check.json'
-          use-quiet-mode: 'yes'
-          use-verbose-mode: 'yes'
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          reporter: github-pr-review
+          fail_on_error: true
diff --git a/.markdown-link-check.json b/.markdown-link-check.json
deleted file mode 100644
index 12284d673..000000000
--- a/.markdown-link-check.json
+++ /dev/null
@@ -1,10 +0,0 @@
-{
-  "ignorePatterns": [
-    {
-      "pattern": "^http://localhost"
-    }
-  ],
-  "timeout": "5s",
-  "retryOn429": true,
-  "aliveStatusCodes": [200, 206, 429]
-}
diff --git a/instrumentation/active_model_serializers/README.md b/instrumentation/active_model_serializers/README.md
index 728cdf74b..7e8fe0bd5 100644
--- a/instrumentation/active_model_serializers/README.md
+++ b/instrumentation/active_model_serializers/README.md
@@ -32,7 +32,7 @@ end
 
 ## Examples
 
-Example usage of active_model_serializers can be seen in the `./example/active_model_serializers.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/active_model_serializers/example/active_model_serializers.rb)
+Example usage of active_model_serializers can be seen in the `./example/` folder [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/active_model_serializers/example)
 
 ## How can I get involved?