docker-library / docker-library/docs

Wishlist: play with "linkinator" to validate our links

Open
#2,048 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
5.3k
Forks
2.2k
Avg merge
1d 18h
Merged PRs (30d)
11

Description

https://github.com/JustinBeckwith/linkinator-action (and thus https://github.com/JustinBeckwith/linkinator) looks super interesting, and IMO it'd be really fun if we could run it automatically on PRs (and perhaps on everything on a schedule?) to validate that all our links are legit.

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.

Research direction

Start by reviewing the linked linkinator-action and linkinator repositories to understand their supported inputs and outputs. Then locate this repository's existing GitHub Actions workflows, if any, and determine how pull-request and scheduled runs should be represented. Done means the agreed link validation runs in the requested contexts and reports failures clearly.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.