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

Prevent or detect broken links to internal pages #10

Closed
lbianchi-lbl opened this issue Feb 15, 2023 · 1 comment · Fixed by #11
Closed

Prevent or detect broken links to internal pages #10

lbianchi-lbl opened this issue Feb 15, 2023 · 1 comment · Fixed by #11
Assignees
Labels
enhancement New feature or request question Further information is requested

Comments

@lbianchi-lbl
Copy link
Collaborator

After noticing a broken internal link in one of the pages I've written (#9) I've also looked into a few ways to reduce the chance of this happening in the future:

A) https://github.com/benbalter/jekyll-relative-links: a Jekyll extension that allows using relative paths to Markdown files as a way to specify internal links (i.e. the way it works on GitHub)
B) Add a CI check for broken links, e.g. https://github.com/gjtorikian/html-proofer, using GitHub Actions

Disclaimer:

  • I don't have much experience with Jekyll (these are just things I've found during a 10-minute search), so I definitely don't have strong preferences or opinions on how to go about
  • If you (and the technical/website folks in particular @mrmundt @cabejackson in particular) think this could be useful, I'd be happy to try and throw together a quick GitHub Actions workflow to run the linkchecker for PRs
@lbianchi-lbl lbianchi-lbl added enhancement New feature or request question Further information is requested labels Feb 15, 2023
@lbianchi-lbl lbianchi-lbl self-assigned this Feb 15, 2023
@mrmundt
Copy link
Contributor

mrmundt commented Feb 15, 2023

@lbianchi-lbl - We actually have a linting workflow on the main USRSE/usrse.github.io repository that we can re-use. Link: https://github.com/USRSE/usrse.github.io/blob/main/.github/workflows/linting.yaml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request question Further information is requested
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants