main page file deduplication & broken links with rdoc 8

Ouverte
#1,750 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
48/100
Type d'issue
Bug
Clarté
Plutôt claire
Activité
Calme
Stack technique
ruby
Domaine
documentation

Piste de recherche

Commencez par examiner PR #1624 et comparez les sorties générées par RDoc 7 et RDoc 8 pour README_md.html et index.html. Suivez la manière dont sont sélectionnés l’URL de la page principale et les liens entrants, puis définissez et vérifiez le comportement attendu pour les liens README_md.html existants sans restaurer de contenu redondant.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
Ruby
Étoiles
928
Forks
471
Merge moyen
2 j 4 min
PR mergées (30 j)
13

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de ruby/rdoc

Toutes les issues de ruby/rdoc

Issues similaires

Plus d'issues Ruby

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.