1 |
Hola a todos: |
2 |
|
3 |
Tras la reciente aprobación de la normativa del grupo[1], ha llegado el |
4 |
momento de comenzar a ponerla en práctica. Lo único que necesitamos es |
5 |
elegir el mecanismo mediante el cual registraremos qué documento está |
6 |
asignado a cada responsable y que tareas sobre documentos libres se |
7 |
están llevando a cabo actualmente. |
8 |
|
9 |
Hay un par de posibilidades para esto: |
10 |
|
11 |
1. Utilizar trads.rb |
12 |
|
13 |
Trads.rb es un script (en ruby) que se encarga de generar una lista, con |
14 |
información muy completa sobre el estado de la documentación. Podeis |
15 |
verlo en la página del grupo francés [2] o polaco [3]. |
16 |
|
17 |
Puntos fuertes: |
18 |
|
19 |
a) Muy potente |
20 |
|
21 |
Puntos débiles: |
22 |
|
23 |
a) Necesita una máquina host con el repositorio gentoo, solamente |
24 |
disponible para desarrolladores. |
25 |
|
26 |
b) Se basa en el concepto de revisión cvs, en lugar de versión xml como |
27 |
tiene overview, teniendo que notificarse manualmente (por medio del |
28 |
desarrollador) cada vez que se realiza algún commit al cvs, para |
29 |
reflejar que el documento está actualizado. |
30 |
|
31 |
2. Lista de responsables sobre overview |
32 |
|
33 |
Actualmente trabajamos con overview.xml [4], me parece la manera más |
34 |
sencilla de comprobar el estado de la documentación. Si a esto le |
35 |
añadimos una columna más con el responsable, creo que tenemos todo lo |
36 |
que nos hace falta. Algo así como lo que tienen los italianos [5], pero |
37 |
más completo. |
38 |
|
39 |
He implementado un feo hack[6] en python, que hace esto mismo: descarga |
40 |
el overview.xml actual y le añade una columna de responsable, colocando |
41 |
en cada documento el responsable que le corresponde que lee de un fichero. |
42 |
|
43 |
Puntos fuertes: |
44 |
|
45 |
a) Muy automático: actualiza el overview via cron dos veces cada día, no |
46 |
es necesario que ningún desarrollador marque nada cuando se hace un |
47 |
commit, el propio overview reflejará la actualización. |
48 |
|
49 |
b) Todos los desarrolladores (chiguire, anpereir y yo, actualmente) |
50 |
pueden ejecutar el script (ya que está en nuestra máquina |
51 |
dev.gentoo.org) y, lo que es más importante, modificar el archivo de |
52 |
responsables, salvando de esta manera un posible cuello de botella en |
53 |
caso de que uno no esté disponible. |
54 |
|
55 |
Puntos débiles: |
56 |
|
57 |
a) Es un feo feo hack sobre el html del overview que seguramente nunca |
58 |
debió escribirse, pero se aceptan soluciones mejores con el mismo |
59 |
resultado ;) |
60 |
|
61 |
b) Inconsistente frente a cambios (serios) en el overview. |
62 |
|
63 |
El script lleva funcionando dos semanas, sin errores. Además, como |
64 |
medidad de detección de errores, comprueba si algún |
65 |
documento/responsable en el fichero de responsables no fue asignado y,de |
66 |
ser así, envía un correo notificandolo (sucede cuando se elimina un |
67 |
documento del overview o si hubiera algún cambio en el propio html). |
68 |
|
69 |
A parte de esto, para las tareas que se realizan sobre documentos |
70 |
libres, seguiremos empleando gentoo.es[7] como hasta el momento. Lo |
71 |
único que no será necesario que los responsables notifiquen allí nada |
72 |
cuando trabajen sobre sus docs. |
73 |
|
74 |
Yo personalmente prefiero evitar todo el trabajo manual, por parte de |
75 |
una sola persona que conlleva trads.rb. Quizá pueda estar equivocado, |
76 |
pero sería crear un cuello de botella o una dependencia de alguien excesiva. |
77 |
|
78 |
Ideas, flames, dudas ... ? |
79 |
|
80 |
Un saludo. |
81 |
|
82 |
[1] http://dev.gentoo.org/~yoswink/doc/es/ |
83 |
[2] http://dev.gentoo.org/~neysx/ |
84 |
[3] http://dev.gentoo.org/~rane/trads.xml |
85 |
[4] http://www.gentoo.org/doc/es/overview.xml |
86 |
[5] http://dev.gentoo.org/~so/ |
87 |
[6] http://dev.gentoo.org/~yoswink/tmp/gen-doc-es/over-extended.html |
88 |
[7] http://www.gentoo-es.org/project/issues/125 |
89 |
|
90 |
-- |
91 |
Jose Luis Rivero [yoswink@g.o] |
92 |
Gentoo/Doc Gentoo/Alpha |
93 |
-- |
94 |
gentoo-doc-es@g.o mailing list |