Hotfix: Add tests to check for broken links

[dylanPowers]

It would be good to have a tool that can test for broken links and give us a little piece of mind that we aren't frustrating anyone out there.

Tools:

• A nodejs tool be ideal to reduce the dependencies, but none of them seem to work correctly. Currently looking into http://wummel.github.io/linkchecker/

[dylanPowers]

http://wummel.github.io/linkchecker/ works really well. The only disadvantage is that it doesn't parse the fragment links and see if the html id tags exist. We should integrate it into the build to be ran before deployment.

[harlantwood]

Maybe it could work on CI...

[dylanPowers]

We haven't set up CI for this yet, but that's a good idea.

[jbenet]

+1

[meiqimichelle]

This may also work (haven't tried it, just happened to see it): https://github.com/peaceiris/actions-hugo-link-check

[jessicaschilling]

@cwaring -- Discovered this when grooming stale issues. Can we please check in about the best way to get it included in future efforts? Seems it manifests/would manifest in two ways:

1. for main ipfs.io site, ideally in CI (do we already do this, actually?)
2. for revamped docs site (is this already in your requirements list?)

[cwaring]

It would be great to have this at CI level for immediate alerts, however now that we have Google Search Console enabled we should receive alerts for any 404s which will also help us take appropriate care with any inbound redirects that we may have missed.

A blend of the two methods would be ideal for full coverage but I'm confident that the GSC provides robust coverage for now - especially if we emit a sitemap.xml with every new update.

[jessicaschilling]

@cwaring - Thank you, makes sense. Closing this issue with the caveat that we remain aware of this as we revamp overall docs platform.