python / python/docs-community

Improve documentation search from python.org

Offen
#154 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

discuss with PSF
Vorherrschende Sprache
Makefile
Sterne
55
Forks
26
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Use case

A new user makes a good point that searching python.org is unhelpful: https://www.python.org/search/?q=json.dumps . The search returns "No results found." The current Django python.org search only searches the site's content itself.

Goal

Improve the user experience.

Considerations

The python.org site is a PSF asset and changes to the site would need to be supported by PSF and their infra team.

Possible solutions from least effort to most effort

  • Do nothing. Keep the status quo.
  • Make the PSF aware of this behavior and ask what they would like to do
  • Work with PSF to implement an addition to the search results page on python.org: "If you don't find what you need here, try searching at https://docs.python.org/"
  • Add an explicit documentation search button that redirects to docs.python.org's search.
  • Develop integrated search on python.org site. This would be a PSF effort.

Summary

For now this is a bit out of scope for the docs-community to tackle alone. Any change would be a joint PSF and CPython docs effort with the PSF taking the lead. cc/ @python/editorial-board

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 damit, das aktuelle Django-Suchverhalten unter python.org/search/?q=json.dumps nachzustellen, und vergleiche es mit der Sucherfahrung auf docs.python.org. Besprich die vorgeschlagenen Optionen mit der PSF und ihrem Infrastrukturteam; als abgeschlossen gilt die Arbeit erst, wenn ein abgestimmter, von der PSF unterstützter Umfang vorliegt, nicht wenn eine unabhängige Änderung der Docs-Community umgesetzt wurde.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
django
Bereich
documentation, search
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
18/100

Neue Issues direkt in Ihr Postfach

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