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 markdown link validation workflows #352

Open
1 task
adhilto opened this issue Aug 15, 2024 · 0 comments
Open
1 task

Add markdown link validation workflows #352

adhilto opened this issue Aug 15, 2024 · 0 comments
Assignees
Labels
Milestone

Comments

@adhilto
Copy link
Collaborator

adhilto commented Aug 15, 2024

💡 Summary

Add GitHub workflows to validate that the links in our markdown files are not broken. We might want a few different workflows:

  • One that runs regularly (maybe nightly) and checks the links across the all markdown files
  • One that triggers when a markdown file is changed and validates just that file
  • One to be triggered just before a release that validates all links

Motivation and context

We keep finding broken links. Content owners can change their URLs at any time and we need a mechanism for fast detection.

Implementation notes

There are already tools that have been built for this kind of thing. One that I know of: https://github.com/gaurav-nelson/github-action-markdown-link-check

Acceptance criteria

  • workflows have been added
@adhilto adhilto added this to the Driftwood milestone Sep 17, 2024
@adhilto adhilto self-assigned this Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

1 participant