Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
Signed-off-by: Kingdon Barrett <[email protected]>
  • Loading branch information
Kingdon Barrett committed Aug 17, 2023
1 parent 4fe0593 commit 2a43434
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

This link checker is so-named because it was mostly written by ChatGPT.

It is designed for use with the FluxCD website preview environments:
It is designed for use with the FluxCD website preview environments (but it
could easily work with any Netlify or probably whatever other PaaS account):

```ruby
ruby main.rb deploy-preview-1573--fluxcd.netlify.app
Expand All @@ -17,8 +18,14 @@ Assuming it runs to completion, it will produce a report in report.csv

I can import this report into Google Drive and mark it up as I fix the links.

This nearly works as a CI check, but we will need to fix many of the links
first, and find a way to make exceptions for any more that cannot be fixed.
This nearly works as a CI check now! We still have to test it by including in
the fluxcd/website repository.

### Bad UX: Report Download

When the PR check fails, you can download a zip file with a CSV report in it.
The bot might also comment on your PR. It's trying to get you to reduce the
report noise. If you do what it says, then this ugly report will go away! ✅

### Broken feature: Sitemap Caching

Expand Down

0 comments on commit 2a43434

Please sign in to comment.