Skip to content

Sprint de documentación

Patricio Paez edited this page Jan 31, 2016 · 1 revision

Resumen de ideas que discutimos en LinuxCabal el sábado 30 de enero de 2016, acerca de oganizar un sprint para atraer participantes al proyecto y mejorar la documentación. Sergio, Fabián, Patricio.

objetivo

Agregar desarrolladores y probadores al proyecto empezando por usar cada una de las aplicaciones, aprender los conceptos involucrados y el entorno en el que se usan después documentar basados en la experiencia

requisitos

  • obtener la CIEC
  • cuenta en github
  • Python 3, Sphinx, git, mumble instalados

preparación

  • un issue 'sprint de documentación' en github listando lo que necesitamos en cada capítulo
  • contar con el servidor mumble de fipasoft o alterno
  • crear una encuesta sobre
    • nivel de habilidad en Python, git, Sphinx, structured text, setup.py setuptools pip pyvenv
    • trabajo previo en proyectos de software libre
    • si tienen cuenta en github y clave CIEC del SAT
    • nombre y correo
  • crear poster promocional .svg

convocatoria

  • convocar en lista Python México
  • recibir encuesta de los interesados
  • filtrar participantes: pedir a los que no cumplen perfil que aprendan por su cuenta tales temas
  • reunir un mínimo
  • definir la fecha y horario
  • definir una sala con wifi en Guadalajara y reservar
  • definir el proceso
    • escoge un capítulo y notifica al grupo
    • crea una rama sobre develop
    • escribe texto para el capítulo en el .rst
    • envia tus cambios a tu fork
    • crea un pull request sobre lc/develop
    • espera comentarios o merge
    • si es necesario, agrega cambios
    • pide ayuda por mumble o su chat
  • definir el estilo de la documentación

actividades antes del sprint

Pueden ser en PythonCabal grabar cápsulas de 5-10 miutos

  • tutorial Sphinx y structured text

actividades el día del sprint

  • abrir sesión mumble para hablar con foráneos
  • explicar configuración de git user email personal
  • explicar el proceso
  • pedir comida