33Guía para contribuir en la traducción
44=====================================
55
6- ¡Muchas gracias por tu interés en participar de la traducción de la documentación oficial de Python al Español!
7- Necesitamos *mucho * de tu ayuda para poder seguir adelante con este proyecto.
6+ ¡Muchas gracias por tu interés en participar de la traducción de la
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.
10+
11+ Este es el grupo de trabajo para la traducción de la
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.
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.
17+
18+ - Esta traducción es mantenida por personas de todo el mundo que hablan el
19+ idioma Español. No queremos atarla a ninguna región en particular y creemos
20+ que es un valor extra la diversidad de la misma. Vas a encontrar secciones
21+ con diferentes tonalidades de países, regiones o estilos. Lo único que pedimos
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
24+ otro lado pueda entender lo que estamos escribiendo (no usar lunfardo o
25+ regionalismos muy propios de un único lugar).
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.
30+
31+ - En muchos casos el mejor criterio es pensar en el vocabulario que utilizamos
32+ cuando le explicamos a otra persona, o en el trabajo. En muchas ocasiones la
33+ versión en inglés o “spanglish” de la palabra es mucho mejor que decir “git
34+ unir” (para git merge).
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.
38+
39+ - Colaborar haciendo reviews también es muy muy importante, así que si
40+ tienes un rato libre puedes comenzar por mirar los PRs pendientes de revisar.
41+
42+ - Último pero no menos importante, divertite y contá con la ayuda de todes. Te
43+ esperamos en nuestro chat en telegram. ¡Gracias!
44+
845
946.. note ::
1047
1148 Si tienes cualquier duda, puedes enviarnos un email a docs-es@python.org.
1249
1350
51+ ¡Comienza a traducir!
52+ ---------------------
53+
1454#. Crea un fork del repositorio _.
1555
1656 .. note ::
@@ -27,28 +67,32 @@ Necesitamos *mucho* de tu ayuda para poder seguir adelante con este proyecto.
2767
2868#. Agrega el repositorio original como "upstream"::
2969
30- git remote add upstream https://github.com/pycampes /python-docs-es.git
70+ git remote add upstream https://github.com/python /python-docs-es.git
3171
32- #. Crea una rama nueva en base al artículo en el que vayas a trabajar.
33- Por ejemplo, si vas a trabajar en el archivo ``glosario.po ``, usa un nombre similar a::
72+ #. Crea una rama nueva en base al artículo en el que vayas a trabajar. Por
73+ ejemplo, si vas a trabajar en el archivo ``glosario.po ``, usa un nombre
74+ similar a::
3475
3576 git checkout -b traduccion-glosario
3677
37- #. Una vez que hayas elegido el archivo, lo puedes abrir con el editor poedit _ y empezar a traducir.
78+ #. Una vez que hayas elegido el archivo, lo puedes abrir con el editor poedit _ y
79+ empezar a traducir.
3880
39- #. Cuando hayas terminado tu sesión, debes guardar tus cambios y enviarlos a GitHub de nuevo::
81+ #. Cuando hayas terminado tu sesión, debes guardar tus cambios y enviarlos a
82+ GitHub de nuevo::
4083
41- git commit -am 'Traducido archivo {nombre de archivo}'
42- git push origin traduccion-glosario
84+ git commit -am 'Traducido archivo {nombre de archivo}' git push origin
85+ traduccion-glosario
4386
44- #. No olvides añadir tu nombre al archivo ``TRANSLATORS `` si no lo has hecho todavía.
45- Los nombres se encuentran ordenados alfabéticamente por apellido.
87+ #. No olvides añadir tu nombre al archivo ``TRANSLATORS `` si no lo has hecho
88+ todavía. Los nombres se encuentran ordenados alfabéticamente por apellido.
4689
4790#. Luego ve a tu página de GitHub y propone hacer un *Pull Request *.
4891
4992 .. note ::
5093
51- Puedes consultar la `ayuda oficial de GitHub para crear un Pull Request `_ si lo deseas.
94+ Puedes consultar la `ayuda oficial de GitHub para crear un Pull Request `_
95+ si lo deseas.
5296
5397#. En la descripción de la *Pull Request * escribe ``Closes #<número de issue> ``
5498 (así se cierra automáticamente cuando se hace *merge *)
@@ -57,8 +101,9 @@ Necesitamos *mucho* de tu ayuda para poder seguir adelante con este proyecto.
57101¿Qué archivo traducir?
58102----------------------
59103
60- Tenemos una `lista de issues en GitHub `_ en dónde vamos coordinando el trabajo realizado para no traducir dos veces lo mismo.
61- El proceso para traducir un archivo es el siguiente:
104+ Tenemos una `lista de issues en GitHub `_ en dónde vamos coordinando el trabajo
105+ realizado para no traducir dos veces lo mismo. El proceso para traducir un
106+ archivo es el siguiente:
62107
63108
64109#. Elige cualquier de los que *no están asignados * a otra persona.
@@ -72,57 +117,66 @@ A tener en cuenta
72117-----------------
73118
74119* No debes traducir el contenido de ``:ref:... `` y ``:term:... ``.
75- * Si tienes que usar palabras en inglés debes ponerlas en *italics * (rodeadas por asteriscos)
76- * Si traduces un título que es un link, por favor traduce el link también (por ejemplo un artículo a Wikipedia).
77- En caso de que no haya una traducción del artículo en Wikipedia deja el título sin traducir.
78- * Tenemos una `Memoria de Traducción `_, que usamos para tener consistencia con algunos términos.
79- * Si tienes una duda sobre una palabra o término, escríbelo como mejor suene para vos y
80- marca ese párrafo como "Need work" / "Necesita trabajo" en *poedit *.
81- Además, escribe un comentario explicando cuál es el termino en ese párrafo con el que no estabas segura.
82- * Puedes usar `la traducción al Portugués `_ para ver cómo ellos hicieron la traducción de alguna palabra.
83- * Wikipedia puede ser útil también. Busca la palabra en Inglés, y luego mira si tiene una traducción
84- al Español en la barra de la izquierda. Suelen estar bastante bien explicados.
85120
121+ * Si tienes que usar palabras en inglés debes ponerlas en *italics * (rodeadas
122+ por asteriscos)
86123
87- .. note ::
124+ * Puedes revisar las :doc: ` faq ` para leer sobre problemas conocidos.
88125
89- 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.
90129
130+ * Tenemos una `Memoria de Traducción `_, que usamos para tener consistencia con
131+ algunos términos.
91132
92- Previsualizar los cambios
93- -------------------------
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.
94137
95- Hay dos formas de visualizar, junto con el resultado final de la documentación, 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.
96140
97- Read the Docs
98- `````````````
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.
99149
100- Una vez que hayas hecho un Pull Request en GitHub, este mostrará al final de página una sección de "check".
101- Allí debería haber uno que diga ``docs/readthedocs.org:python-docs-es `` y al lado un link de "Details".
102150
103- Haciendo click en ese link verás una versión de la documentación con tus cambios.
151+ .. note ::
104152
105- Construcción local
106- ``````````````````
153+ También puedes unirte a `nuestro canal de Telegram `_ si necesitas ayuda.
107154
108- Desde el mismo directorio ``python-docs-es/ `` que se creó cuando hiciste ``git clone `` puedes ejecutar::
109155
110- make build
156+ Previsualizar los cambios
157+ -------------------------
111158
112- Este comando demorará unos minutos y generará toda la documentación en formato HTML en tu computadora .
113- Puedes ver el resultado con tu navegador de internet (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".
114161
115- make serve
162+ .. figure :: readthedocs-preview.png
163+ :width: 85%
164+ :align: center
116165
117- 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.
118168
119169
120- .. _repositorio : https://github.com/PyCampES/python-docs-es
121- .. _ayuda oficial de GitHub : https://help.github.com/es/github/getting-started-with-github/fork-a-repo
122- .. _ayuda oficial de GitHub para crear un Pull Request : https://help.github.com/es/github/collaborating-with-issues-and-pull-requests/about-pull-requests
170+ .. _repositorio : https://github.com/python/python-docs-es
171+ .. _ayuda oficial de GitHub :
172+ https://help.github.com/es/github/getting-started-with-github/fork-a-repo
173+ .. _ayuda oficial de GitHub para crear un Pull Request :
174+ https://help.github.com/es/github/collaborating-with-issues-and-pull-requests/about-pull-requests
123175.. _poedit : https://poedit.net/
124176
125177.. _nuestro canal de Telegram : https://t.me/python_docs_es
126- .. _Memoria de traducción : https://python-docs-es.readthedocs.io/page/translation-memory.html
178+ .. _Memoria de traducción :
179+ https://python-docs-es.readthedocs.io/page/translation-memory.html
127180.. _la traducción al Portugués : https://docs.python.org/pt-br/3/
128- .. _lista de issues en GitHub : https://github.com/PyCampES/python-docs-es/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
181+ .. _lista de issues en GitHub :
182+ https://github.com/python/python-docs-es/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+no%3Aassignee+translate
0 commit comments