Hola a todos:
Tras la reciente aprobación de la normativa del grupo[1], ha llegado el
momento de comenzar a ponerla en práctica. Lo único que necesitamos es
elegir el mecanismo mediante el cual registraremos qué documento está
asignado a cada responsable y que tareas sobre documentos libres se
están llevando a cabo actualmente.
Hay un par de posibilidades para esto:
1. Utilizar trads.rb
Trads.rb es un script (en ruby) que se encarga de generar una lista, con
información muy completa sobre el estado de la documentación. Podeis
verlo en la página del grupo francés [2] o polaco [3].
Puntos fuertes:
a) Muy potente
Puntos débiles:
a) Necesita una máquina host con el repositorio gentoo, solamente
disponible para desarrolladores.
b) Se basa en el concepto de revisión cvs, en lugar de versión xml como
tiene overview, teniendo que notificarse manualmente (por medio del
desarrollador) cada vez que se realiza algún commit al cvs, para
reflejar que el documento está actualizado.
2. Lista de responsables sobre overview
Actualmente trabajamos con overview.xml [4], me parece la manera más
sencilla de comprobar el estado de la documentación. Si a esto le
añadimos una columna más con el responsable, creo que tenemos todo lo
que nos hace falta. Algo así como lo que tienen los italianos [5], pero
más completo.
He implementado un feo hack[6] en python, que hace esto mismo: descarga
el overview.xml actual y le añade una columna de responsable, colocando
en cada documento el responsable que le corresponde que lee de un fichero.
Puntos fuertes:
a) Muy automático: actualiza el overview via cron dos veces cada día, no
es necesario que ningún desarrollador marque nada cuando se hace un
commit, el propio overview reflejará la actualización.
b) Todos los desarrolladores (chiguire, anpereir y yo, actualmente)
pueden ejecutar el script (ya que está en nuestra máquina
dev.gentoo.org) y, lo que es más importante, modificar el archivo de
responsables, salvando de esta manera un posible cuello de botella en
caso de que uno no esté disponible.
Puntos débiles:
a) Es un feo feo hack sobre el html del overview que seguramente nunca
debió escribirse, pero se aceptan soluciones mejores con el mismo
resultado ;)
b) Inconsistente frente a cambios (serios) en el overview.
El script lleva funcionando dos semanas, sin errores. Además, como
medidad de detección de errores, comprueba si algún
documento/responsable en el fichero de responsables no fue asignado y,de
ser así, envía un correo notificandolo (sucede cuando se elimina un
documento del overview o si hubiera algún cambio en el propio html).
A parte de esto, para las tareas que se realizan sobre documentos
libres, seguiremos empleando gentoo.es[7] como hasta el momento. Lo
único que no será necesario que los responsables notifiquen allí nada
cuando trabajen sobre sus docs.
Yo personalmente prefiero evitar todo el trabajo manual, por parte de
una sola persona que conlleva trads.rb. Quizá pueda estar equivocado,
pero sería crear un cuello de botella o una dependencia de alguien excesiva.
Ideas, flames, dudas ... ?
Un saludo.
[1] http://dev.gentoo.org/~yoswink/doc/es/
[2] http://dev.gentoo.org/~neysx/
[3] http://dev.gentoo.org/~rane/trads.xml
[4] http://www.gentoo.org/doc/es/overview.xml
[5] http://dev.gentoo.org/~so/
[6] http://dev.gentoo.org/~yoswink/tmp/gen-doc-es/over-extended.html
[7] http://www.gentoo-es.org/project/issues/125
--
Jose Luis Rivero [yoswink@g.o]
Gentoo/Doc Gentoo/Alpha
--
gentoo-doc-es@g.o mailing list
|