Set up a watcher for link rot

Open
#13 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
github-actions
Domain
ci-cd, documentation

Research direction

Start by reviewing the proposed puppeteer-crawler and the script issues mentioned in the issue, then determine how to run it as a weekly GitHub Action. Exclude pages under /v2, /v3, /v4, and /v5, and consider the work done when maintained documentation links are checked and 404 notifications are delivered.

Written by the indexing model from the issue text.

Description

At least some of the links referenced by the documentation will inevitably die.

We could use something like https://github.com/ephys/puppeteer-crawler to be notified when a link becomes a 404.

I still need to fix some issues with that script first.

We should also not check pages under /v2, /v3, /v4, and /v5 since these versions are not maintained anymore and it would skyrocket the time needed to check.

We probably can do this with a github action that runs once a week.

Dominant language
HTML
Stars
30
Forks
170
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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.

More from sequelize/website

All issues in sequelize/website

Similar issues

More DevOps issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.