Skip to content

Commit

Permalink
📝 Fixes broken links in docs (#310)
Browse files Browse the repository at this point in the history
  • Loading branch information
Lissy93 committed Nov 5, 2021
1 parent 8bff833 commit 5f9d165
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 2 deletions.
14 changes: 14 additions & 0 deletions .github/.lycheeexclude
Original file line number Diff line number Diff line change
@@ -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/**
7 changes: 6 additions & 1 deletion .github/workflows/docs-link-checker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/status-indicators.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 5f9d165

Please sign in to comment.