golang/go

all: builders and TryBots should check documentation for broken links

Open

#37.047 aperta il 5 feb 2020

Vedi su GitHub
 (9 commenti) (5 reazioni) (0 assegnatari)Go (19.008 fork)batch import
BuildersDocumentationNeedsInvestigationTestinghelp wanted

Metriche repository

Star
 (133.883 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

We occasionally end up with broken or outdated links in documentation (see #46545, https://github.com/golang/go/issues/37042#issuecomment-582448476, #27860, #21951, #19244).

Testing for broken links would not be entirely trivial, but nonetheless pretty straightforward to implement: we have an HTML parser in golang.org/x/net/html, and it is easy enough to issue a HEAD request for link targets to see if they resolve. (For links with anchors, we would probably want to also check the Content-Type header and then parse the actual linked HTML to ensure that the anchor exists.)

CC @golang/osp-team

Guida contributor

Direzione di ricerca
Implementa uno strumento Go usando golang.org/x/net/html per analizzare la documentazione HTML, inviare richieste HEAD a ciascun link, verificare il Content Type per gli ancoraggi e segnalare i link interrotti. Integra con il sistema di build (TryBot) per l'esecuzione automatica sulle modifiche alla documentazione.
Tech stack
go
Dominio
documentationdevops
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GoHTML parsingHTTP/HTTPS requests
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65