Link checker across nix documentation properties

Aperta
#841 4 commenti 2 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma

Direzione di ricerca

Inizia esaminando come vengono prodotti i siti di documentazione compilati e dove sono definiti i workflow CI. Confronta l’approccio proposto con il verificatore dei link dei libri di Cargo, quindi determina come leggere l’HTML compilato, convalidare i file di destinazione e gli ancoraggi in repository versionati separatamente ed eseguire il controllo in CI. Il lavoro è completato quando i link non funzionanti vengono rilevati automaticamente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

site

Observations

If we add more links, they might break. We can automate finding broken links between our things, in principle, and run it in ci. One difficulty is that the repos aren't versioned together but this could be overcome.

Cargo's book has a link checker iirc, could maybe use that.

Problem

With more links come more possibilities to break them. We could catch the breakage automatically.

Approaches

Write script that reads html files of built sites, soups the links out, and validates the target files exist with the appropriate anchors. Run in CI here or elsewhere.

Willing to help?

Sure

Priorities

Add 👍 to issues you find important.

Lingua principale
Nix
Stelle
4k
Fork
343
Merge medio
20h 27m
PR unite (30g)
10

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di NixOS/nix.dev

Tutte le issue di NixOS/nix.dev

Issue simili

Altre issue su DevOps

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.