Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change broken link checker to linkspector #1802

Open
tuminoid opened this issue Jun 20, 2024 · 1 comment
Open

Change broken link checker to linkspector #1802

tuminoid opened this issue Jun 20, 2024 · 1 comment
Assignees
Labels
kind/feature Categorizes issue or PR as related to a new feature. triage/accepted Indicates an issue is ready to be actively worked on.

Comments

@tuminoid
Copy link
Member

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

  • Broken link checker is migrated to the linkspector.
  • Issues related to broken links in CAPM3 and metal3-docs rechecked for validity, new ones to be opened and false positives closed.

/kind feature

@metal3-io-bot metal3-io-bot added kind/feature Categorizes issue or PR as related to a new feature. needs-triage Indicates an issue lacks a `triage/foo` label and requires one. labels Jun 20, 2024
@tuminoid
Copy link
Member Author

/triage accepted
/assign

@metal3-io-bot metal3-io-bot added triage/accepted Indicates an issue is ready to be actively worked on. and removed needs-triage Indicates an issue lacks a `triage/foo` label and requires one. labels Jun 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature. triage/accepted Indicates an issue is ready to be actively worked on.
Projects
Status: CAPM3 WIP
Development

No branches or pull requests

2 participants