fix comments

.github/workflows/check-edit-links.yml

@@ -1,4 +1,4 @@
-name: Weekly Link Checker
+name: Weekly Docs Link Checker
 
 on:
   schedule:
@@ -17,7 +17,7 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: '20'
+          node-version-file: '.nvmrc'
 
       - name: Install dependencies
         run: npm install
@@ -40,7 +40,7 @@ jobs:
         uses: rtCamp/action-slack-notify@v2
         env:
           SLACK_WEBHOOK: ${{ secrets.WEBSITE_SLACK_WEBHOOK }}
-          SLACK_TITLE: 'Edit Links Checker Errors Report'
+          SLACK_TITLE: 'Docs Edit Link Checker Errors Report'
           SLACK_MESSAGE: |
             🚨 The following URLs returned 404 during the link check:
             ```

package.json

@@ -24,7 +24,7 @@
     "generate:tools": "node scripts/build-tools.js",
     "test:netlify": "deno test --allow-env --trace-ops netlify/**/*.test.ts",
     "test:md": "node scripts/markdown/check-markdown.js",
-    "test:editlinks": "node scripts/markdown/check-editlinks.js",
+    "test:editlinks": "node scripts/markdown/check-edit-links.js",
     "dev:storybook": "storybook dev -p 6006",
     "build:storybook": "storybook build"
   },

scripts/dashboard/build-dashboard.js

@@ -181,4 +181,4 @@ if (require.main === module) {
   start(resolve(__dirname, '..', '..', 'dashboard.json'));
 }
 
-module.exports = { getLabel, monthsSince, mapGoodFirstIssues, getHotDiscussions, getDiscussionByID, getDiscussions, writeToFile, start, processHotDiscussions };
+module.exports = { getLabel, monthsSince, mapGoodFirstIssues, getHotDiscussions, getDiscussionByID, getDiscussions, writeToFile, start, processHotDiscussions, pause };

scripts/markdown/check-editlinks.js → scripts/markdown/check-edit-links.js

@@ -2,23 +2,14 @@ const fs = require('fs').promises;
 const path = require('path');
 const fetch = require('node-fetch-2');
 const editUrls = require('../../config/edit-page-config.json');
+const { pause } = require('../dashboard/build-dashboard');
 
 const ignoreFiles = [
   'reference/specification/v2.x.md',
   'reference/specification/v3.0.0-explorer.md',
   'reference/specification/v3.0.0.md'
 ];
 
-/**
- * Introduces a delay in the execution flow
- * @param {number} ms - The number of milliseconds to pause
- */
-async function pause(ms) {
-  return new Promise((res) => {
-    setTimeout(res, ms);
-  });
-}
-
 /**
  * Process a batch of URLs to check for 404s
  * @param {object[]} batch - Array of path objects to check

tests/markdown/check-editlinks.test.js → tests/markdown/check-edit-links.test.js

@@ -1,13 +1,13 @@
 const path = require('path');
 const fetch = require('node-fetch-2');
-const editOptions = require('../fixtures/markdown/edit-page-config.json');
+const editOptions = require('../../config/edit-page-config.json');
 const {
   generatePaths,
   processBatch,
   checkUrls,
   determineEditLink,
   main
-} = require('../../scripts/markdown/check-editlinks');
+} = require('../../scripts/markdown/check-edit-links');
 const { determineEditLinkData, processBatchData, testPaths } = require('../fixtures/markdown/check-editlinks-data');
 
 jest.mock('node-fetch-2', () => jest.fn());