docs: update action for link check and fix one broken link (#1322)

fix: update action for link check and fix one broken link
open-telemetry · Jan 6, 2025 · 67c9a02 · 67c9a02
1 parent 97955b0
commit 67c9a02
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 16 deletions.
diff --git a/.github/workflows/ci-markdown-link.yml b/.github/workflows/ci-markdown-link.yml
@@ -2,16 +2,19 @@ name: Markdown Link Check
 
 on:
   pull_request:
+    paths:
+      - '**/*.md'
 
 jobs:
   markdown-link-check:
     runs-on: ubuntu-latest
     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
diff --git 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?