JuliaDocs/Documenter.jl

Follow redirects when linkchecking

Open

#1,354 opened on Jun 30, 2020

View on GitHub
 (0 comments) (1 reaction) (0 assignees)Julia (513 forks)batch import
Type: Enhancementhelp wanted

Repository metrics

Stars
 (910 stars)
PR merge metrics
 (Avg merge 16d 9h) (3 merged PRs in 30d)

Description

Suggested by @charleskawczynski in https://github.com/JuliaDocs/Documenter.jl/issues/1344#issuecomment-649951413: for the temporary 3XX redirects, we should maybe follow the redirect URL and check if the redirect destination is a working URL. If not, then also treat that as a linkcheck error.

Contributor guide

Research direction
Implement logic to follow HTTP 3XX redirects during link checking. Modify the existing link checker to detect redirect responses, fetch the redirect target, and report if that target is broken.
Tech stack
julia
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JuliaHTTP
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65