main page file deduplication & broken links with rdoc 8

Aperta
#1,750 0 commenti 0 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
48/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
ruby
Ambito
documentation

Direzione di ricerca

Inizia esaminando PR #1624 e confronta gli output generati da RDoc 7 e RDoc 8 per README_md.html e index.html. Traccia come vengono selezionati l’URL della pagina principale e i link in entrata, quindi definisci e verifica il comportamento previsto per i link README_md.html esistenti senza ripristinare contenuti ridondanti.

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

Descrizione

PR #1624 removed the redundant main-page file. That is easily the correct behaviour, but existing projects may have that URL published/indexed/linked externally, and regenerating with rdoc 8 could now break inbound links.

In my own case, a README_md.html no longer existed because it duplicated index.html, and this broke one of my own bookmarks to my own project because I hadn't pinned rdoc 7 for the CI publish action. No doubt other folks will also get some surprise 404s.

Lingua principale
Ruby
Stelle
928
Fork
471
Merge medio
2g 4m
PR unite (30g)
13

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 ruby/rdoc

Tutte le issue di ruby/rdoc

Issue simili

Altre issue su Ruby

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.