python / python/docs-community

Cut the whale of the changelog into manageable pieces?

Abierto
#98 8 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

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

Descripción

The changelog page is very long:

It's currently 219,974 words, that's longer than Moby Dick (212,794 words)... 🐳

It contains all the NEWS entries back to Python 3.5.0 alpha 1 (February 8, 2015).

It loads okay on deskstop, but my phone struggles to render it, and the browser hangs when trying to search for text.

I tried to check the accessibility report using Google's PageSpeed Insights:

It shows good initial numbers:

image

But the rest of the report is missing: "Oops! Something went wrong. generic::deadline_exceeded: Render timeout received in extension."

image

Shall we break the changelog page into smaller, more manageable chunks?

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

Comienza con la página del changelog en https://docs.python.org/dev/whatsnew/changelog.html e investiga cómo se ensamblan y publican sus entradas NEWS. Define un enfoque de chunking que preserve el historial del changelog y, al mismo tiempo, mejore la representación en dispositivos móviles, la búsqueda del navegador y la accesibilidad; después, verifica las páginas resultantes con comprobaciones de rendimiento móvil.

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

Evaluación

Stack tecnológico
python
Área
documentation
Tipo de issue
Documentación
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.