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

Periodically checking external links in documentation #3321

Open
thunder-coding opened this issue Oct 8, 2021 · 1 comment
Open

Periodically checking external links in documentation #3321

thunder-coding opened this issue Oct 8, 2021 · 1 comment
Labels

Comments

@thunder-coding
Copy link
Contributor

I had recently sent a PR to fix a broken link in documentation in: #3312

For checking broken links, I had used an open source link checking tool called lychee. The same lychee tool can also be used as GitHub Actions using https://github.com/lycheeverse/lychee-action. We can use this action to periodically check for broken links and also on PRs to make sure that it doesn't include broken links.

If you want to see am example of how this can be done, lychee docs are itself checked with lychee. See https://github.com/lycheeverse/lychee/blob/master/.github/workflows/links.yml

This has been opened up for discussion on recommendation in #3312 (comment)

@stale
Copy link

stale bot commented Jan 9, 2022

This issue has been automatically marked as stale because it has not had recent activity. Thank you for your contributions.

@stale stale bot added the stale label Jan 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant