Automatizar ayudas a la revisión

[astrojuanlu]

Cosas que se me ocurren después de #44:

• Comprobar la ortografía
• Comprobar que hay un summary
• Tener algo tipo staging.pybonacci.org donde se despliega el último pull request para poder ver el resultado sin tener que bajarse el código

¿Qué más echáis en falta?

[kikocorreoso]

En WP la edición era manual también. Era más cómoda porque lo hacías en el mismo site pero no mucho más.

Comprobar la ortografía

Para el tema de ortografía me parece que no hay muchas opciones.

Comprobar que hay un summary

En el notebook se pueden añadir metadatos globales. Podemos meter ahí lo que quieren meter los autores (tags, summary,...) y que algún programa y la CI se dedique a ver si eso aparece y si no está que directamente mande mensaje en el PR con lo que falta.

Tener algo tipo staging.pybonacci.org donde se despliega el último pull request para poder ver el resultado sin tener que bajarse el código

No lo veo necesario. Si algo aparece con una érrata pues se commitea corregido y listo. Yo, ahora que he revisado los posts antiguos, además de que me dan vergüenza ajena 😃 me he encontrado multitud de erratas (y nadie se ha quejado después de años).

No se me ocurren muchas cosas pero la idea era que fuera super KISS... 😗

[astrojuanlu]

Queremos que sea KISS, y también queremos quitarnos trabajo manual... Todo depende de dónde pongas el KISS :)

• Ortografía: https://blog.eleven-labs.com/en/how-to-check-the-spelling-of-your-docs-from-travis-ci/
• Summary: grep PELICAN_BEGIN_SUMMARY + https://stackoverflow.com/a/38550849/554319

[asdf8601]

Os comento una idea por si os puede ser de ayuda. No se si habéis pensado meter un template en los PR para colaboradores, como tienen en Pandas:

• https://github.com/pandas-dev/pandas/blob/master/.github/PULL_REQUEST_TEMPLATE.md
• https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/

Cuya adaptación imagino que podría ser algo como:

• Revisión de ortografía
• Añadir summary
• lo que sea...

Esto les sirve tanto al colaborador como a los editores.

[astrojuanlu]

¡Buena idea @mmngreco! Nos lo dejamos como tarea pendiente, es un buen primer paso.

[asdf8601]

Me he topado con este repo que parece que hace spell checking en español :

• https://github.com/lukeapage/node-markdown-spellcheck#spanish---es-es

[manugarri]

@mmngreco me parece genia la idea de la plantilla!

[kikocorreoso]

He creado una plantilla aquí:

https://github.com/Pybonacci/pybonacci.github.io/blob/sources/.github/PULL_REQUEST_TEMPLATE.md

Revisadla y modificadla como consideréis.

@Juanlu001 No entiendo muy bien:

grep PELICAN_BEGIN_SUMMARY + https://stackoverflow.com/a/38550849/554319

Lo de spell checking con código markdown o en notebook no sé muy bien si dará muchos falsos positivos. Habrá que refinarlo bastante y ver cómo va.

@mmngreco @manugarri @Juanlu001 @AlexS12 Se agradecen ideas y modificaciones para hacerlo lo más sencillo posible.

[astrojuanlu]

Me parece muy bien la plantilla!

@kikocorreoso con el escueto comentario de grep ... quería decir que se puede automatizar un chequeo de tal forma que si el usuario ha escrito un artículo que no tiene resumen, lo avise. Pero eso se puede hacer en un futuro.

Cambio el título al issue y el milestone.

[manugarri]

@kikocorreoso me parece genial la plantilla. Una cosa que les digo a mis alumnos siempre es que para comprobar que un notebook se ejecuta, hagan lo de "Restart and Run All". A lo mejor podemos añadir eso?

[kikocorreoso]

Podemos hacer obligatorio el incluir un environment.yml en cada aporte, de tal forma que se puede reproducir en mybinder por cualquier tercero o en travisCI o en gitlabCI usando jupyter y un conda env: https://nbconvert.readthedocs.io/en/latest/execute_api.html#executing-notebooks-from-the-command-line

Votad si os parece bien: @manugarri , @Juanlu001 , @AlexS12 Con dos votos positivos (yo no voto para que no haya empates) lo llevamos adelante para un milestone futuro.

Para la parte de mybinder (reproducibilidad) he abierto un issue en binderhub para ver si podríamos tener un detalle más fino a la hora de lanzar dependencias solo para un notebook específico (jupyterhub/binderhub#555).

Para la parte de CI, reproducir el notebook con un environment específico, se puede implementar a la de ya. Con travis no ando muy para allá, estoy usando bastante más gitlabCI. ¿Voluntarios?

Con las respuestas que me déis abro varios issues...

[astrojuanlu]

Los environment.yml tienen un bug infame que los hace bastante problemáticos: conda/conda#5901

[kikocorreoso]

hay otros 'dependencies' file en mybinder. No necesariamente debe ser un environment.yml. Se puede usar Dockerfile, requirements.txt,... ¿Para usos simples para validar algún notebook y ejecutarlo de forma remota en mybinder no lo ves viable? ¿Alternativas para poder automatizar un poco más al trabajo previo de validar que el notebook se ejecuta correctamente en el entorno propuesto?

[astrojuanlu]

Depende del estándar de calidad que busquemos... Antes que exigirlo a otros intentaría que nosotros mismos seamos capaces de hacerlo 😉