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

Fix broken links in Markdown files #1996

Merged
merged 2 commits into from
Sep 27, 2024
Merged

Conversation

replaceafill
Copy link
Member

This also introduces markdown-link-check as a pre-commit hook to check broken links in the Markdown files of the repository. The hook has been set as manual to not interfere in the usual development workflow.

For example, to check links in a specific file:

pre-commit run --hook-stage manual markdown-link-check --files src/dashboard/frontend/README.md

Or to check all the Markdown files in the repository:

pre-commit run --hook-stage manual markdown-link-check --all-files

We should not include this in the pull request workflow because link checking is flaky. Sometimes working links fail from GitHub hosts because websites block them. But we could potentially create a separate workflow that developers could trigger manually.

This also introduces `markdown-link-check` as a `pre-commit` hook to
check broken links in the Markdown files of the repository. The hook
has been set as `manual` so developers need to run it explicitly.
@replaceafill replaceafill requested a review from a team September 27, 2024 18:52
Copy link
Contributor

@Dhwaniartefact Dhwaniartefact left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this. LGTM !

@replaceafill replaceafill merged commit 46a1eb8 into qa/1.x Sep 27, 2024
26 checks passed
@replaceafill replaceafill deleted the dev/fix-markdown-links branch September 27, 2024 20:41
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

Successfully merging this pull request may close these issues.

2 participants