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

Add test to validate broken links in markdown files #4342

Closed
wearyzen opened this issue Dec 22, 2023 · 2 comments
Closed

Add test to validate broken links in markdown files #4342

wearyzen opened this issue Dec 22, 2023 · 2 comments

Comments

@wearyzen
Copy link
Contributor

We have lot of links in our md files which are broken and could be broken due to refactoring of code.
We need to add a new CI test which checked for all the links in all the md files in the repo.
The discussion started with #4341 (comment)
and we found mlc which can validate all links in the md files however it fails to validate links that are embedded like https://github.com/firecracker-microvm/firecracker/blob/main/docs/getting-started.md?plain=1#L79

The new test should cover links in all md files (embedded in code or not).

@andr3wy
Copy link
Contributor

andr3wy commented Apr 3, 2024

Hi everyone,

We're a group at UT Austin and we're interested in picking this issue up.

@roypat
Copy link
Contributor

roypat commented Aug 12, 2024

Hey all,
We added a test to ensure that inter-markdown links are not broken in #4421. We decided against adding something that also validates external links to our CI for multiple reasons:

  1. We do not want to send a bunch of HTTP requests to random websites every time a PR gets updated
  2. Events external to this repository could cause the test to fail (say a temporary outage of a linked website), causing such a test to fail intermittently
  3. The mlc tool above has a lot of false positives (for example regarding images embedded in markdown).

For these reasons, we are closing this issue

@roypat roypat closed this as not planned Won't fix, can't repro, duplicate, stale Aug 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants