Skip to content

Commit 5f9d165

Browse files
committed
📝 Fixes broken links in docs (Lissy93#310)
1 parent 8bff833 commit 5f9d165

File tree

3 files changed

+21
-2
lines changed

3 files changed

+21
-2
lines changed

.github/.lycheeexclude

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Ignore list, for automated broken link checking
2+
3+
https://fonts.gstatic.com/**
4+
https://metager.org/meta/**
5+
https://developers.cloudflare.com/**
6+
7+
http://localhost**
8+
https://localhost**
9+
http://192.168**
10+
https://192.168**
11+
file:///github/**
12+
http://[dashy-location]**
13+
https://[dashy-location]**
14+
**.local/**

.github/workflows/docs-link-checker.yml

+6-1
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,15 @@ jobs:
1111
steps:
1212
- uses: actions/checkout@v2
1313

14+
- name: Load Excludes
15+
run: |
16+
LYCHEE_EXCLUDE=$(sed -e :a -e 'N;s/\n/ /;ta' .github/.lycheeexclude)
17+
echo "LYCHEE_EXCLUDE=$LYCHEE_EXCLUDE" >> $GITHUB_ENV
18+
1419
- name: Check for Broken Links
1520
uses: lycheeverse/[email protected]
1621
with:
17-
args: --verbose -a 200,302,304,429 --no-progress **/*.md **/*.html
22+
args: --verbose -a 200,302,304,429 --exclude ${{ env.LYCHEE_EXCLUDE }} --exclude-mail --no-progress **/*.md
1823
env:
1924
GITHUB_TOKEN: ${{secrets.BOT_GITHUB_TOKEN}}
2025
LYCHEE_OUT: .github/broken-link-report.md

docs/status-indicators.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ If the status is always returning an error, despite the service being online, th
6565
If your service requires requests to include any authorization in the headers, then use the `statusCheckHeaders` property, as described above.
6666
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:
6767
```
68-
Access-Control-Allow-Origin: https://location-of-dashy/
68+
Access-Control-Allow-Origin: https://[dashy-location]/
6969
Vary: Origin
7070
```
7171
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.

0 commit comments

Comments
 (0)