update broken links report

Author: btylerburton

.github/workflows/qa.yml

@@ -1,28 +1,13 @@
-name: QA Static Site
+name: QA
 
 on:
   workflow_dispatch:
   schedule:
-    - cron: "0 15 * * 1"
+    - cron: '0 15 * * 1'
 
 jobs:
   qa:
-    name: QA Static Site
-    runs-on: ubuntu-latest
-    steps:
-      - name: checkout
-        uses: actions/checkout@v3
-      - uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true
-      - uses: actions/setup-node@v4
-        with:
-          node-version: '20'
-      - name: USWDS
-        run: |
-          npm install
-          npm run gulp
-      - name: Build static site
-        run: bundle exec jekyll build
-      - name: Test External Links
-        run: bundle exec htmlproofer --check-html _site
+    uses: gsa/data.gov/.github/workflows/static-site-qa-template.yml@main
+    with:
+      site_url: https://sdg.data.gov
+      issue_number: 1140

README.md

@@ -2,29 +2,30 @@
 
 This is a starter repository to help in implementing the [Open SDG](https://github.com/open-sdg/open-sdg) platform. [See here for documentation](https://open-sdg.readthedocs.io).
 
-### Requirements
+## Requirements
 
 -   [Ruby](https://www.ruby-lang.org/en/) > 3.0
 -   [Bundler](https://bundler.io/) > 2.0
 
-# Usage
+## Usage
 | Command | Description |
 |---------|-------------|
 | `bundle install` | install the current dependencies |
 | `bundle exec jekyll build` | build the site. dumps to `_site` |
 | `bundle exec jekyll serve` | builds the site and serves it locally |
 
-### Publication 
+## Publication 
 - the static sites created using this repo are configured to be published by pages.cloud.gov via webhooks. For more information on cloud.gov pages visit the [website](https://cloud.gov/pages/)
 
-### Requirements
+## Requirements
 
 -   [Ruby](https://www.ruby-lang.org/en/) = 2.6.0
 -   [Bundler](https://bundler.io/) > 2.0
 -   [Node](https://nodejs.org/en/download/) > 16.0
 
 NOTE: You must build this repo with Ruby 2.6.0. 
-### Setup
+
+## Setup
 
 After you've confirmed the above requirements, all lifecycle operations can be run with NPM scripts (ex. `npm run build`)
 
@@ -36,6 +37,17 @@ After you've confirmed the above requirements, all lifecycle operations can be r
 | test        | Check for broken internal links |
 | qa          | Check for broken external links |
 
+## Broken Links
+
+We run a [weekly QA cron job](https://github.com/GSA/sdg-indicators-usa/actions/workflows/qa.yml) to test for broken links.
+
+Any errors the QA job finds will be added to the [📌 Link Checker Report](https://github.com/GSA/sdg-indicators-usa/issues/1140).
+
+False positives, or URLs you wish to ignore can be put in the `.lycheeignore` file. This supports regex matching as well.
+
+This job can also be run locally. Install instructions here: https://lychee.cli.rs/installation/
+
+Then run with args: `lychee --base=https://sdg.data.gov .`
 
 ## Contributing