From 5f9d1656256dde4cd1bad2fe388795ff0b093ffa Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Fri, 5 Nov 2021 18:50:51 +0000 Subject: [PATCH] :memo: Fixes broken links in docs (#310) --- .github/.lycheeexclude | 14 ++++++++++++++ .github/workflows/docs-link-checker.yml | 7 ++++++- docs/status-indicators.md | 2 +- 3 files changed, 21 insertions(+), 2 deletions(-) create mode 100644 .github/.lycheeexclude diff --git a/.github/.lycheeexclude b/.github/.lycheeexclude new file mode 100644 index 00000000..58461b09 --- /dev/null +++ b/.github/.lycheeexclude @@ -0,0 +1,14 @@ +# Ignore list, for automated broken link checking + +https://fonts.gstatic.com/** +https://metager.org/meta/** +https://developers.cloudflare.com/** + +http://localhost** +https://localhost** +http://192.168** +https://192.168** +file:///github/** +http://[dashy-location]** +https://[dashy-location]** +**.local/** \ No newline at end of file diff --git a/.github/workflows/docs-link-checker.yml b/.github/workflows/docs-link-checker.yml index 527b5af9..c344774c 100644 --- a/.github/workflows/docs-link-checker.yml +++ b/.github/workflows/docs-link-checker.yml @@ -11,10 +11,15 @@ jobs: steps: - uses: actions/checkout@v2 + - name: Load Excludes + run: | + LYCHEE_EXCLUDE=$(sed -e :a -e 'N;s/\n/ /;ta' .github/.lycheeexclude) + echo "LYCHEE_EXCLUDE=$LYCHEE_EXCLUDE" >> $GITHUB_ENV + - name: Check for Broken Links uses: lycheeverse/lychee-action@v1.0.8 with: - args: --verbose -a 200,302,304,429 --no-progress **/*.md **/*.html + args: --verbose -a 200,302,304,429 --exclude ${{ env.LYCHEE_EXCLUDE }} --exclude-mail --no-progress **/*.md env: GITHUB_TOKEN: ${{secrets.BOT_GITHUB_TOKEN}} LYCHEE_OUT: .github/broken-link-report.md diff --git a/docs/status-indicators.md b/docs/status-indicators.md index 7bc866ae..0c473e8e 100644 --- a/docs/status-indicators.md +++ b/docs/status-indicators.md @@ -65,7 +65,7 @@ If the status is always returning an error, despite the service being online, th If your service requires requests to include any authorization in the headers, then use the `statusCheckHeaders` property, as described above. If you are still having issues, it may be because your target application is blocking requests from Dashy's IP. This is a [CORS error](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS), and can be fixed by setting the headers on your target app, to include: ``` -Access-Control-Allow-Origin: https://location-of-dashy/ +Access-Control-Allow-Origin: https://[dashy-location]/ Vary: Origin ``` If the URL you are checking is not using HTTPS, then you may need to disable the rejection of insecure requests. This can be done by setting `statusCheckAllowInsecure` to true for a given item.