Add target for detecting broken links in documentation

[rodrigc]

Solves #956

[NissesSenap]

This is really nice could you add this to be run during CI as well. Maybe a bit painful to run each PR. But it could be something that runs as a cronjob that runs ones a week.

Or what do you think?

It also seems like there are a few broken links already

➜ muffet --rate-limit=3 --max-connections=10 --buffer-size=8192 http://localhost:1313
http://localhost:1313/blog/
        404     https://github.com/grafana-operator/grafana-operator/edit/master/hugo/content/en/blog/_index.md
        404     https://github.com/grafana-operator/grafana-operator/tree/master/hugo/content/en/blog/_index.md
http://localhost:1313/docs/
        404     https://github.com/grafana-operator/grafana-operator/edit/master/hugo/content/en/docs/_index.md
        404     https://github.com/grafana-operator/grafana-operator/tree/master/hugo/content/en/docs/_index.md
http://localhost:1313/blog/2023/03/29/install-grafana-operator-using-flux-and-kustomize/
        404     http://grafana.127.0.0.1.nip.io
        404     https://github.com/grafana-operator/grafana-operator/edit/master/hugo/content/en/blog/kustomize-installation.md
        404     https://github.com/grafana-operator/grafana-operator/tree/master/hugo/content/en/blog/kustomize-installation.md

Either we try to ignore them in the test, or I guess we fix it.

[rodrigc]

I didn't want to add it to CI just yet, because I found while testing that if you bang github too hard,
github enforces rate limits and then you get lots of 429 errors.

There is a GH action which uses muffet which we can pull in later if we want:
https://github.com/ruzickap/action-my-broken-link-checker

[rodrigc]

I would ignore the errors for now, and just fix them on by one.

For this one:

http://grafana.127.0.0.1.nip.io

That's an example, so won't work anyways.

For these ones:

https://github.com/grafana-operator/grafana-operator/edit/master/hugo/content/en/docs/_index.md
https://github.com/grafana-operator/grafana-operator/tree/master/hugo/content/en/docs/_index.md

This is related to the values of github_repo, github_subdir, and github_branch in config.toml.
I'm not sure at the moment how to fix those.

[NissesSenap]

Yeah I think we should shrink the scope and ignore github.com links all together for now.

I have did similar things to did in the flux project and there it worked in one of their repos due to the limited links they had in it. But in another repo we had to ignore github.com links due to the rate limiting even happens if you have a github API token it just comes a bit later.

[NissesSenap]

@rodrigc as described in https://github.com/awsugcz/awsug.cz/blob/main/.github/workflows/periodic-broken-link-checks.yml it seems like all we need to do is to add --exclude=(github.com) and it should fix our issues.
Sure, we won't find broken github links, but it's a good start.

Do you have time to take a look at the PR again?

[rodrigc]

@rodrigc as described in https://github.com/awsugcz/awsug.cz/blob/main/.github/workflows/periodic-broken-link-checks.yml it seems like all we need to do is to add --exclude=(github.com) and it should fix our issues. Sure, we won't find broken github links, but it's a good start.

Do you have time to take a look at the PR again?

@NissesSenap OK, I added --exclude

[github-actions]

This PR hasn't been updated for a while, marking as stale

[NissesSenap]

Sorry for the delay with a review on this @rodrigc .
LGTM