python / python/docs-community

Improve documentation search from python.org

Abierto
#154 3 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

discuss with PSF
Lenguaje dominante
Makefile
Estrellas
55
Forks
26
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Empieza reproduciendo el comportamiento actual de búsqueda de Django en python.org/search/?q=json.dumps y compáralo con la experiencia de búsqueda en docs.python.org. Revisa las opciones propuestas con la PSF y su equipo de infraestructura; el trabajo solo se considerará terminado cuando exista un alcance acordado y respaldado por la PSF, no cuando se haya realizado un cambio independiente de la comunidad de documentación.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
django
Área
documentation, search
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
18/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.