Skip to content

Commit 0997463

Browse files
cmaureircmaureir
authored
Merge branch '3.8' into traduccion-object
2 parents f9b2da6 + fe40a5a commit 0997463

38 files changed

+9993
-1825
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ __pycache__/
2222

2323
# Distribution / packaging
2424
venv
25+
.venv
2526
.Python
2627
env/
2728
build/

‎.overrides/CONTRIBUTING.rst

+106-48
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,54 @@
33
Guí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,38 +67,48 @@ 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*)
5599

100+
.. note::
101+
102+
Si hace tiempo que venis trabajando en una traducción es importante
103+
mantener actualizada tu copia local antes de realizar el *Pull Request**
104+
56105

57106
¿Qué archivo traducir?
58107
----------------------
59108

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:
109+
Tenemos una `lista de issues en GitHub`_ en dónde vamos coordinando el trabajo
110+
realizado para no traducir dos veces lo mismo. El proceso para traducir un
111+
archivo es el siguiente:
62112

63113

64114
#. Elige cualquier de los que *no están asignados* a otra persona.
@@ -72,58 +122,66 @@ A tener en cuenta
72122
-----------------
73123

74124
* 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-
* Puedes revisar las :doc:`faq` para leer sobre problemas conocidos.
77-
* Si traduces un título que es un link, por favor traduce el link también (por ejemplo un artículo a Wikipedia).
78-
En caso de que no haya una traducción del artículo en Wikipedia deja el título sin traducir.
79-
* Tenemos una `Memoria de Traducción`_, que usamos para tener consistencia con algunos términos.
80-
* Si tienes una duda sobre una palabra o término, escríbelo como mejor suene para vos y
81-
marca ese párrafo como "Need work" / "Necesita trabajo" en *poedit*.
82-
Además, escribe un comentario explicando cuál es el termino en ese párrafo con el que no estabas segura.
83-
* Puedes usar `la traducción al Portugués`_ para ver cómo ellos hicieron la traducción de alguna palabra.
84-
* Wikipedia puede ser útil también. Busca la palabra en Inglés, y luego mira si tiene una traducción
85-
al Español en la barra de la izquierda. Suelen estar bastante bien explicados.
86125

126+
* Si tienes que usar palabras en inglés debes ponerlas en *italics* (rodeadas
127+
por asteriscos)
87128

88-
.. note::
129+
* Puedes revisar las :doc:`faq` para leer sobre problemas conocidos.
89130

90-
También puedes unirte a `nuestro canal de Telegram`_ si necesitas ayuda.
131+
* Si traduces un título que es un link, por favor traduce el link también (por
132+
ejemplo un artículo a Wikipedia). En caso de que no haya una traducción del
133+
artículo en Wikipedia deja el título sin traducir.
91134

135+
* Tenemos una `Memoria de Traducción`_, que usamos para tener consistencia con
136+
algunos términos.
92137

93-
Previsualizar los cambios
94-
-------------------------
138+
* Si tienes una duda sobre una palabra o término, escríbelo como mejor suene
139+
para vos y marca ese párrafo como "Need work" / "Necesita trabajo" en
140+
*poedit*. Además, escribe un comentario explicando cuál es el termino en ese
141+
párrafo con el que no estabas segura.
95142

96-
Hay dos formas de visualizar, junto con el resultado final de la documentación, los cambios que has hecho.
143+
* Puedes usar `la traducción al Portugués`_ para ver cómo ellos hicieron la
144+
traducción de alguna palabra.
97145

98-
Read the Docs
99-
`````````````
146+
* Wikipedia puede ser útil también. Busca la palabra en Inglés, y luego mira si
147+
tiene una traducción al Español en la barra de la izquierda. Suelen estar
148+
bastante bien explicados.
149+
150+
* Te recomendamos abrir una Pull Request aunque sea en formato borrador (marcada
151+
como draft) desde los primeros commits de la traducción de tu fichero. De esta
152+
forma, puedes recibir feedback desde el principio que puedes aplicar al resto
153+
de la traducción, y probar el build más a menudo.
100154

101-
Una vez que hayas hecho un Pull Request en GitHub, este mostrará al final de página una sección de "check".
102-
Allí debería haber uno que diga ``docs/readthedocs.org:python-docs-es`` y al lado un link de "Details".
103155

104-
Haciendo click en ese link verás una versión de la documentación con tus cambios.
156+
.. note::
105157

106-
Construcción local
107-
``````````````````
158+
También puedes unirte a `nuestro canal de Telegram`_ si necesitas ayuda.
108159

109-
Desde el mismo directorio ``python-docs-es/`` que se creó cuando hiciste ``git clone`` puedes ejecutar::
110160

111-
make build
161+
Previsualizar los cambios
162+
-------------------------
112163

113-
Este comando demorará unos minutos y generará toda la documentación en formato HTML en tu computadora.
114-
Puedes ver el resultado con tu navegador de internet (Firefox, Chrome, etc) ejecutando::
164+
Una vez que hayas hecho un *Pull Request* en GitHub, este mostrará al final de página una sección de "check".
165+
Allí debería haber uno que diga ``docs/readthedocs.org:python-docs-es`` y al lado un link de "Details".
115166

116-
make serve
167+
.. figure:: readthedocs-preview.png
168+
:width: 85%
169+
:align: center
117170

118-
Y luego accediendo a http://localhost:8000/
171+
Haciendo click en ese link verás una versión de la documentación completa que incluirá todos tus cambios.
172+
Tendrás que navegar hasta el archivo que hayas cambiado para ver cómo se visualiza luego del build.
119173

120174

121-
.. _repositorio: https://github.com/PyCampES/python-docs-es
122-
.. _ayuda oficial de GitHub: https://help.github.com/es/github/getting-started-with-github/fork-a-repo
123-
.. _ayuda oficial de GitHub para crear un Pull Request: https://help.github.com/es/github/collaborating-with-issues-and-pull-requests/about-pull-requests
175+
.. _repositorio: https://github.com/python/python-docs-es
176+
.. _ayuda oficial de GitHub:
177+
https://help.github.com/es/github/getting-started-with-github/fork-a-repo
178+
.. _ayuda oficial de GitHub para crear un Pull Request:
179+
https://help.github.com/es/github/collaborating-with-issues-and-pull-requests/about-pull-requests
124180
.. _poedit: https://poedit.net/
125181

126182
.. _nuestro canal de Telegram: https://t.me/python_docs_es
127-
.. _Memoria de traducción: https://python-docs-es.readthedocs.io/page/translation-memory.html
183+
.. _Memoria de traducción:
184+
https://python-docs-es.readthedocs.io/page/translation-memory.html
128185
.. _la traducción al Portugués: https://docs.python.org/pt-br/3/
129-
.. _lista de issues en GitHub: https://github.com/PyCampES/python-docs-es/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
186+
.. _lista de issues en GitHub:
187+
https://github.com/python/python-docs-es/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+no%3Aassignee+translate

‎.overrides/faq.rst

+37
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,13 @@ y repetir el proceso para *Smart Dashes*.
8989
Desactivar "Smart Quotes" y "Smart Dashes"
9090

9191

92+
.. tip::
93+
94+
Este comando te puede ayudar a cambiar todas las comillas::
95+
96+
sed -i **/*.po -e 's|[“”]|\\"|g'
97+
98+
9299
¿Qué parte de ``:ref:`` debo traducir?
93100
--------------------------------------
94101

@@ -150,3 +157,33 @@ Luego, cada vez que realices un commit se ejecutará ``pre-commit`` y validará
150157

151158
Si por cualquier motivo no está funcionando ``pre-commit`` y no te deja hacer *push* de tus cambios,
152159
lo puedes desinstalar simplemente mediante: ``pre-commit uninstall``.
160+
161+
162+
¿Cómo puedo hacer un *build* local de la documentación?
163+
-------------------------------------------------------
164+
165+
.. note::
166+
167+
Necesitas un poco de conocimiento para instalar ``make`` en tu sistema operativo.
168+
169+
Desde el mismo directorio ``python-docs-es/`` que se creó cuando hiciste ``git clone`` puedes ejecutar::
170+
171+
make build
172+
173+
Este comando demorará unos minutos y generará toda la documentación en formato HTML en tu computadora.
174+
Puedes ver el resultado con tu navegador de internet (Firefox, Chrome, etc) ejecutando::
175+
176+
make serve
177+
178+
Y luego accediendo a http://localhost:8000/
179+
180+
181+
¿Tienen una lista de correo?
182+
----------------------------
183+
184+
Sí.
185+
186+
No tiene mucho tráfico aún ya que estamos usando más el canal de Telegram por el momento.
187+
Puedes suscribirte ingresando aquí_.
188+
189+
.. _aquí: https://mail.python.org/mailman3/lists/docs-es.python.org/

‎.overrides/progress.rst

+18-1
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,25 @@ y otras estadísticas.
1010

1111
.. note::
1212

13-
Esta lista se actualiza automáticamente cuando Pull Requests se *mergean* a la rama ``3.8``.
13+
Estas listas se actualiza automáticamente cuando Pull Requests se *mergean* a la rama ``3.8``.
14+
15+
16+
En progreso
17+
-----------
18+
19+
Muestra los porcentajes completados por directorio y solo los archivos que no están al 100%.
1420

1521
.. runblock:: console
1622

1723
$ potodo --offline --path .
24+
25+
26+
Completados
27+
-----------
28+
29+
Lista todos los archivos con un porcentaje de traducción mayor al 90% (para contemplar los que tienen fuzzy).
30+
31+
32+
.. runblock:: console
33+
34+
$ python scripts/completed_files.py

‎.overrides/readthedocs-preview.png

39.6 KB
Loading

0 commit comments

Comments
 (0)