ci: add check for markdown links #912
Conversation
mpoke
requested review from
jtremback,
sainoe,
shaspitz,
MSalopek,
mmulji-ic,
glnro and
yaruwangway
as code owners
might be trying to point here? |
.github/workflows/linkchecker.yml
Outdated
| # Checks the status of hyperlinks in *.md files in docs/ | ||
| - uses: gaurav-nelson/github-action-markdown-link-check@1.0.13 | ||
| with: | ||
| folder-path: "docs" |
There was a problem hiding this comment.
Use docs/docs, please.
docs/docs is the only folder that gets published on the docs web page:
Nothing outside of docs/docs is available on the docs web page. Not anything else should be linted for broken links.
You can check this branch to confirm:
The branch is controlled by this action:
There was a problem hiding this comment.
Its a bit odd to use docs / docs, but beyond the scope of this PR to look into it
There was a problem hiding this comment.
Given that we have .md files in docs, we should make sure that everything there works. Otherwise we should just remove it. For example, docs/old/testing.md contains info that we refer to from the main README.md.
There was a problem hiding this comment.
Now that I think about it, we should probably check README.md also for broken links.
Description
Closes: NA
Add CI check for markdown links in ./docs and fixing broken links
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
Reviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...