python / python/docs-community
Improve documentation search from python.org
Personne n'a encore pris cette issue.
- Langage dominant
- Makefile
- Étoiles
- 55
- Forks
- 26
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
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
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par reproduire le comportement actuel de la recherche Django sur python.org/search/?q=json.dumps et comparez-le à l’expérience de recherche sur docs.python.org. Examinez les options proposées avec la PSF et son équipe d’infrastructure ; le travail ne sera considéré comme terminé que lorsqu’un périmètre convenu et soutenu par la PSF aura été défini, et non lorsqu’une modification indépendante de la communauté de documentation aura été effectuée.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- django
- Domaine
- documentation, search
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 18/100