1
1
:orphan:
2
2
3
- Guía para contribuir en la traducción
3
+ Guía para contribuir en la traducción
4
4
=====================================
5
5
6
6
¡Muchas gracias por tu interés en participar de la traducción de la
7
7
documentación oficial de Python al Español! Necesitamos *mucho * de tu ayuda
8
- para poder seguir adelante con este proyecto. Te damos la bienvenida y
9
- te agradecemos anticipadamente por tus futuras colaboraciones.
8
+ para poder seguir adelante con este proyecto. Te damos la bienvenida y
9
+ te agradecemos anticipadamente por tus futuras colaboraciones.
10
10
11
11
Este es el grupo de trabajo para la traducción de la
12
12
documentación oficial de Python al Español, todo el contenido de la traducción
13
- es mantenido por voluntaries que aportan su tiempo y trabajo a la comunidad.
13
+ es mantenido por voluntaries que aportan su tiempo y trabajo a la comunidad.
14
14
15
- Antes de comenzar tu primera traducción y que sigas con esta guia de
16
- contribución queremos señalar algunos lineamientos generales.
15
+ Antes de comenzar tu primera traducción, y que sigas con esta guia de
16
+ contribución, queremos señalar algunos lineamientos generales.
17
17
18
18
- Esta traducción es mantenida por personas de todo el mundo que hablan el
19
19
idioma Español. No queremos atarla a ninguna región en particular y creemos
20
20
que es un valor extra la diversidad de la misma. Vas a encontrar secciones
21
21
con diferentes tonalidades de países, regiones o estilos. Lo único que pedimos
22
22
es consistencia dentro de un mismo módulo o sección (es decir no cambiar de
23
- estilo de un párrafo a otro por ejemplo) y siempre intentar que la persona del
23
+ estilo de un párrafo a otro, por ejemplo) y siempre intentar que la persona del
24
24
otro lado pueda entender lo que estamos escribiendo (no usar lunfardo o
25
- regionalismos muy propios de un único lugar)
25
+ regionalismos muy propios de un único lugar).
26
26
27
- - La documentación es ENORME, cualquier traba que encuentres siempre puedes
28
- marcar el texto como “fuzzy” o para revisar en el futuro.
29
- No pierdas horas buscando la palabra perfecta.
27
+ - La documentación es ENORME, cualquier traba que encuentres siempre puedes
28
+ marcar el texto como “fuzzy” o para revisar en el futuro.
29
+ No pierdas horas buscando la palabra perfecta.
30
30
31
31
- En muchos casos el mejor criterio es pensar en el vocabulario que utilizamos
32
32
cuando le explicamos a otra persona, o en el trabajo. En muchas ocasiones la
33
33
versión en inglés o “spanglish” de la palabra es mucho mejor que decir “git
34
34
unir” (para git merge).
35
35
36
- - Siempre vas a tener un review de lo que propongas y en ese intercambio otras
37
- personas van a ayudarte a destrabar las dudas que tengas.
36
+ - Siempre vas a tener un review de lo que propongas y en ese intercambio otras
37
+ personas van a ayudarte a destrabar las dudas que tengas.
38
38
39
39
- Colaborar haciendo reviews también es muy muy importante, así que si
40
40
tienes un rato libre puedes comenzar por mirar los PRs pendientes de revisar.
41
41
42
42
- Último pero no menos importante, divertite y contá con la ayuda de todes. Te
43
- esperamos en nuestro chat en telegram. Gracias!
43
+ esperamos en nuestro chat en telegram. ¡ Gracias!
44
44
45
45
46
46
.. note ::
47
47
48
48
Si tienes cualquier duda, puedes enviarnos un email a docs-es@python.org.
49
49
50
50
51
+ ¡Comienza a traducir!
52
+ ---------------------
53
+
51
54
#. Crea un fork del repositorio _.
52
55
53
56
.. note ::
@@ -95,76 +98,73 @@ contribución queremos señalar algunos lineamientos generales.
95
98
(así se cierra automáticamente cuando se hace *merge *)
96
99
97
100
98
- ¿Qué archivo traducir?
101
+ ¿Qué archivo traducir?
99
102
----------------------
100
103
101
104
Tenemos una `lista de issues en GitHub `_ en dónde vamos coordinando el trabajo
102
105
realizado para no traducir dos veces lo mismo. El proceso para traducir un
103
106
archivo es el siguiente:
104
107
105
108
106
- #. Elige cualquier de los que *no están asignados * a otra persona. #. Deja un
107
- comentario en el issue diciendo que quieres trabajar en él. #. Espera a que
108
- un administrador te asigne el issue. #. ¡Empieza a traducir!
109
+ #. Elige cualquier de los que *no están asignados * a otra persona.
110
+ #. Deja un comentario en el issue diciendo que quieres trabajar en él.
111
+ #. Espera a que un administrador te asigne el issue.
112
+ #. ¡Empieza a traducir!
109
113
110
114
111
115
112
- A tener en cuenta
116
+ A tener en cuenta
113
117
-----------------
114
118
115
- * No debes traducir el contenido de ``:ref:... `` y ``:term:... ``. * Si tienes
116
- que usar palabras en inglés debes ponerlas en *italics * (rodeadas por
117
- asteriscos) * Puedes revisar las :doc: `faq ` para leer sobre problemas
118
- conocidos. * Si traduces un título que es un link, por favor traduce el link
119
- también (por ejemplo un artículo a Wikipedia). En caso de que no haya una
120
- traducción del artículo en Wikipedia deja el título sin traducir. * Tenemos
121
- una `Memoria de Traducción `_, que usamos para tener consistencia con algunos
122
- términos. * Si tienes una duda sobre una palabra o término, escríbelo como
123
- mejor suene para vos y marca ese párrafo como "Need work" / "Necesita trabajo"
124
- en *poedit *. Además, escribe un comentario explicando cuál es el termino en
125
- ese párrafo con el que no estabas segura. * Puedes usar `la traducción al
126
- Portugués `_ para ver cómo ellos hicieron la traducción de alguna palabra. *
127
- Wikipedia puede ser útil también. Busca la palabra en Inglés, y luego mira si
128
- tiene una traducción al Español en la barra de la izquierda. Suelen estar
129
- bastante bien explicados.
119
+ * No debes traducir el contenido de ``:ref:... `` y ``:term:... ``.
130
120
121
+ * Si tienes que usar palabras en inglés debes ponerlas en *italics * (rodeadas
122
+ por asteriscos)
131
123
132
- .. note ::
124
+ * Puedes revisar las :doc: ` faq ` para leer sobre problemas conocidos.
133
125
134
- También puedes unirte a `nuestro canal de Telegram `_ si necesitas ayuda.
126
+ * Si traduces un título que es un link, por favor traduce el link también (por
127
+ ejemplo un artículo a Wikipedia). En caso de que no haya una traducción del
128
+ artículo en Wikipedia deja el título sin traducir.
135
129
130
+ * Tenemos una `Memoria de Traducción `_, que usamos para tener consistencia con
131
+ algunos términos.
136
132
137
- Previsualizar los cambios
138
- -------------------------
133
+ * Si tienes una duda sobre una palabra o término, escríbelo como mejor suene
134
+ para vos y marca ese párrafo como "Need work" / "Necesita trabajo" en
135
+ *poedit *. Además, escribe un comentario explicando cuál es el termino en ese
136
+ párrafo con el que no estabas segura.
139
137
140
- Hay dos formas de visualizar, junto con el resultado final de la documentación,
141
- los cambios que has hecho .
138
+ * Puedes usar ` la traducción al Portugués `_ para ver cómo ellos hicieron la
139
+ traducción de alguna palabra .
142
140
143
- Read the Docs
144
- `````````````
141
+ * Wikipedia puede ser útil también. Busca la palabra en Inglés, y luego mira si
142
+ tiene una traducción al Español en la barra de la izquierda. Suelen estar
143
+ bastante bien explicados.
144
+
145
+ * Te recomendamos abrir una Pull Request aunque sea en formato borrador (marcada
146
+ como draft) desde los primeros commits de la traducción de tu fichero. De esta
147
+ forma, puedes recibir feedback desde el principio que puedes aplicar al resto
148
+ de la traducción, y probar el build más a menudo.
145
149
146
- Una vez que hayas hecho un Pull Request en GitHub, este mostrará al final de
147
- página una sección de "check". Allí debería haber uno que diga
148
- ``docs/readthedocs.org:python-docs-es `` y al lado un link de "Details".
149
150
150
- Haciendo click en ese link verás una versión de la documentación con tus
151
- cambios.
151
+ .. note ::
152
152
153
- Construcción local
154
- ``````````````````
153
+ También puedes unirte a `nuestro canal de Telegram `_ si necesitas ayuda.
155
154
156
- Desde el mismo directorio ``python-docs-es/ `` que se creó cuando hiciste ``git
157
- clone `` puedes ejecutar::
158
155
159
- make build
156
+ Previsualizar los cambios
157
+ -------------------------
160
158
161
- Este comando demorará unos minutos y generará toda la documentación en formato
162
- HTML en tu computadora. Puedes ver el resultado con tu navegador de internet
163
- (Firefox, Chrome, etc) ejecutando::
159
+ Una vez que hayas hecho un *Pull Request * en GitHub, este mostrará al final de página una sección de "check".
160
+ Allí debería haber uno que diga ``docs/readthedocs.org:python-docs-es `` y al lado un link de "Details".
164
161
165
- make serve
162
+ .. figure :: readthedocs-preview.png
163
+ :width: 85%
164
+ :align: center
166
165
167
- Y luego accediendo a http://localhost:8000/
166
+ Haciendo click en ese link verás una versión de la documentación completa que incluirá todos tus cambios.
167
+ Tendrás que navegar hasta el archivo que hayas cambiado para ver cómo se visualiza luego del build.
168
168
169
169
170
170
.. _repositorio : https://github.com/python/python-docs-es
0 commit comments