main page file deduplication & broken links with rdoc 8
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Anfängerfreundlichkeit
- 48/100
- Issue-Typ
- Bug
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Ruhig
- Tech-Stack
- ruby
- Bereich
- documentation
Rechercherichtung
Beginne mit der Prüfung von PR #1624 und vergleiche die von RDoc 7 und RDoc 8 erzeugten Ausgaben für README_md.html und index.html. Verfolge, wie die URL der Hauptseite und eingehende Links ausgewählt werden, und definiere und überprüfe anschließend das erwartete Verhalten für vorhandene README_md.html-Links, ohne redundante Inhalte wiederherzustellen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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.
- Vorherrschende Sprache
- Ruby
- Sterne
- 928
- Forks
- 471
- Ø Merge
- 2 T. 4 Min.
- Gemergte PRs (30 T.)
- 13
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus ruby/rdoc
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
Maintainer antworten meist innerhalb von 1 Tag
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentationEvtl. vergeben @OskarEichler hat das vor 65 Tagen übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100
ruby/rdoc#1759 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
markdown html excerpt includes link partsEvtl. vergeben @anyingiit hat das vor 11 Tagen übernommen. Offen
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 66/100
Maintainer antworten meist innerhalb von 1 Tag
-
Regexp generated from unescaped input in #expand_classEvtl. vergeben @jaynetics hat das vor 23 Tagen übernommen. Offen
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 25/100
Maintainer antworten meist innerhalb von 1 Tag
Ähnliche Issues
-
JWT::EncodedToken raises TypeError for a non-object headerEvtl. vergeben @anakinj hat das heute übernommen. Offenbug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
jwt/ruby-jwt#780 · 1 Reaktion ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 82/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
zold-io/zold-ruby-sdk#85 ·
-
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 62/100