python / python/editorial-board

For readers -- fix the doc links on python.org

Offen
#1 1 Kommentar 3 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

readers
Vorherrschende Sprache
HTML
Sterne
14
Forks
1
Ø Merge
59 Min.
Gemergte PRs (30 T.)
2

Beschreibung

The documentation tab on python.org is not very friendly:

Screenshot 2024-01-08 at 17 20 16

Several links take you to this useless interstitial page: https://www.python.org/doc/ -- instead the tab should take you directly to https://docs.python.org/3/, or at the very least it should have a bold yellow button that takes you there (rather than a gray one).

Some other materials are seriously outdated or limited; the A/V link goes to a page with mostly outdated podcasts, for example (the list of recent PyCon talks is at the bottom). The Beginners link goes to a wiki page. Etc., etc.

  • Link to discussion about the proposal (Discourse or GitHub): not yet

See also: https://docs.google.com/presentation/d/1ujDv8wViPvAMFAtYCRxSKh-CMUlbjcfVYitsqEI2Ios/edit#slide=id.p

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der Prüfung des Dokumentations-Tabs und der in diesem Issue beschriebenen Links, insbesondere /doc/ und https://docs.python.org/3/. Prüfe die verlinkte Präsentation sowie die Ziele A/V und Beginners. Erledigt ist die Aufgabe, wenn der Tab direkt zur aktuellen Dokumentation führt und für die identifizierten veralteten oder eingeschränkten Materialien vereinbarte Ersatzlinks vorhanden sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
html
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
42/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.