metal3-io / cluster-api-provider-metal3

Metal³ integration with https://github.com/kubernetes-sigs/cluster-api
Apache License 2.0
193 stars 87 forks source link

Change broken link checker to linkspector #1802

Open tuminoid opened 1 week ago

tuminoid commented 1 week ago

User Story

We have GH workflow lint-docs.yml which basically runs a dead link check on the markdown files. Maintainer of that action suggest moving to his new https://github.com/UmbrellaDocs/linkspector as it is using headless chrome to inspect the links. This would be helpful in reducing false positives, as for example GH is responding 404 to simple bots trying to read its website. This leads to false positive issues being created.

This same workflow is trying to be added to metal3-docs where we have many more links and it is riddled with false positives.

Detailed Description

/kind feature

tuminoid commented 1 week ago

/triage accepted /assign