matrix-org / matrix-org/matrix.org

Run a broken links checker

Open
#1,908 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
616
Forks
463
Avg merge
2d 3h
Merged PRs (30d)
19

Description

Zola has this built in but it can take several hours to run. While we can't add it to the CI, it's a good idea to run it to see every link that broke in the migration.

@MTRNord I think you had done some work in that direction?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by checking Zola's built-in broken-link checker and how it is run for this site. Run it outside CI, then document the links reported as broken and confirm that the migration's broken links have been identified.

Written by the indexing model from the issue text.

Assessment

Domain
testing-qa, web-dev
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.