Notas de la reunión del equipo de documentación celebrada el día 2024-14-05
Datos de la reunión
Próxima reunión semanal
Revisión del proyecto de traducción y localización de la documentación de usuarios finales
@estelaris Comienza la reunión semanal realizando una revisión del estado de los issues que han sido asignados. El proyecto actualmente queda de la siguiente manera.
Tareas sin asignar
https://github.com/WordPress/spain-handbook/issues/303
https://github.com/WordPress/spain-handbook/issues/304
https://github.com/WordPress/spain-handbook/issues/305
https://github.com/WordPress/spain-handbook/issues/306
https://github.com/WordPress/spain-handbook/issues/307
https://github.com/WordPress/spain-handbook/issues/311
https://github.com/WordPress/spain-handbook/issues/312
https://github.com/WordPress/spain-handbook/issues/313
https://github.com/WordPress/spain-handbook/issues/314
https://github.com/WordPress/spain-handbook/issues/315
https://github.com/WordPress/spain-handbook/issues/316
https://github.com/WordPress/spain-handbook/issues/317
https://github.com/WordPress/spain-handbook/issues/319
https://github.com/WordPress/spain-handbook/issues/320
https://github.com/WordPress/spain-handbook/issues/321
https://github.com/WordPress/spain-handbook/issues/322
En proceso
https://github.com/WordPress/spain-handbook/issues/308
https://github.com/WordPress/spain-handbook/issues/310
https://github.com/WordPress/spain-handbook/issues/318
En revisión por el equipo de documentación
https://github.com/WordPress/spain-handbook/issues/309
En revisión por el equipo de traducción
Ninguna tarea pendiente
Issues terminados
https://github.com/WordPress/spain-handbook/issues/288
https://github.com/WordPress/spain-handbook/issues/290
Tras este resumen del estado del proyecto y habiendo podido realizar las primeras adaptaciones de los artículos, @nilovelez ha encontrado un primer detalle que precisa un afinado. Las palabras destinadas al glosario que se generan, se ha decidido crear un issue para acogerlas todas en ese lugar.
Se ha llegado a la conclusión de que es necesario generar un issue en el equipo de documentación de Global, para la actualización de documentación obsoleta. @estelaris revisará ese proceso y, una vez realizadas las actualizaciones, se podrán realizar las adaptaciones al español.
En los casos en que se realice un issue en global por tener documentación obsoleta se hará mención, mediante enlace, del issue creado. De esa forma no perderemos la referencia ni el contexto del documento.
Permisos; ¿quién y por qué deben tener o no, permisos y sus diferentes niveles?
Tras la solicitud por algunos contribuidores de que se le otorguen permisos, @javiercasares nos realiza un breve resumen en el que explica cómo está estructurado el sistema de los permisos y el porqué de esa estructuración. Quedan definidos los permisos con la siguiente estructura. Ha quedado patente que sin la intención de bloquear a nadie, con el fin de mantener una estructura de mantenimiento óptima.
Manual de Markdown optimizado para trabajar con WordPress
en el Spain handbook tenemos a disposición de todo el equipo de documentación un manual de Markdown creado por @javiercasares que cualquier persona que se interese por crear documentación en GitHub, en cualquiera de los proyectos existentes lo tiene a su disposición para realizar consultas.
Creación de la página de documentación en https://es.wordpress.org /documentation
@estelaris ha creado el issue para la creación de la página de documentación, la cual, quedará separada de los foros donde actualmente conviven las secciones de foros, documentación y colabora.
Artículos obsoletos alojados en los foros de soporte
Tras debatir sobre el contenido de esta sección, se ha acordado que los textos actualizados deberán contener un enlace que haga referencia al texto antiguo. Se debe crear un listado de redirecciones del cual se va a encargar @javiercasares.
Temas pendientes sin tratar de la agenda de esta semana
Queda pendientes para la semana siguiente las propuestas para el Contributor day de la WCEU.
Resumen de la reunión del Spain Handbook
Dado que comienzan a involucrarse de forma más activa equipos como el de Hosting, marketing, y accesibilidad, @javiercasares ha realizado una revisión general de como ha quedado estructurado el Spain Handbook sus diferentes secciones, cómo etiquetar nuevos isues, cómo se debe proceder a la hora de documentar y los filtros por los que deben pasar todos los documentos que se generan ya sean nuevos o revisiones de los ya existentes.
Las revisiones de la documentación subida a GitHub queda sujeta a la forma en la que se presenta en los estados de documentación generados todas las semanas. En ellos se puede apreciar el estado de los issues activos. Dada la extensión en número de los issues sin asignar, no se mencionan directamente. Para verlos simplemente acude al repositorio en GitHub del Spain Handbook, selecciona tu equipo de contribución y a partir de ese momento puedes comenzar a documentar. Si es necesario, incluso creando nuevos issues.
En cuanto a los permisos que ya se han mencionado y debatido en el proyecto de traducción y localización de la documentación de usuarios, aplican los mismos, puesto que todo está incluido dentro del Spain Handbook.
Documentación prioritaria por terminar
Dada la importancia que tiene, el foco principal dentro de Spain Handbook es terminar el manual de GitHub. Este manual junto al manual de Markdown son las piedras angulares para conseguir excelentes aportaciones por parte de todos los contribuidores. Y el equipo de documentación, en conjunto con el resto de equipos que han comenzado a colaborar en sus respectivos espacios, han acordado dar prioridad a finalizar lo poco que queda pendiente. Una vez terminado, cada equipo se centrará en sus propios contenidos.
Hasta la finalización del manual de GitHub se creará un párrafo al comienzo de cada estado de la documentación que haga referencia a que es un apartado prioritario y que, como tal, se invita a hacer foco a cualquiera con ganas de contribuir a ayudar en el proceso de terminarlo. Actualmente faltan 8 issues.
@anagavilan proporcionará ayuda para conseguir esta meta, además de pertenecer al equipo de marketing será la encargada de crear el manual de comunicación para las WordCamp, ese manual será de gran ayuda para futuras WordCamp y en el que está muy interesada @martaliarte.
@anagavilan pregunta concretamente sobre algunos issues del proyecto general, en especial; ser PTE, ser Local Manager o ser GTE. En este apartado se deja enlace a los issues concretos.
@anagavilan pregunta sobre el proceso por el que va pasando cada documento creado. Ese proceso está documentado en los resúmenes semanales, así como en el mismo proyecto a través de las diferentes pestañas. Una vez subido un issue se revisará por el equipo de documentación y, posteriormente, por el equipo de traducción para que, sin entrar en el contenido de fondo, pero sí que debe comprobar que el estilo y el glosario están bien implementados en el documento.
Es conveniente realizar las consultas en el canal de documentación Slack de España con la finalidad de ofrecer la máxima transparencia y que tenga mayor difusión. Es muy probable que esa misma pregunta se la realicen más personas del grupo y, de esa manera, contestar a esas personas con una sola respuesta.
Props a: @estelaris y @glycymeris por la revisión de este resumen.
#github,
#reunion
