env/

build/

Guía para contribuir en la traducción

¡Muchas gracias por tu interés en participar de la traducción de la documentación oficial de Python al Español!

Necesitamos *mucho* de tu ayuda para poder seguir adelante con este proyecto.

¡Muchas gracias por tu interés en participar de la traducción de la

documentación oficial de Python al Español! Necesitamos *mucho* de tu ayuda

para poder seguir adelante con este proyecto. Te damos la bienvenida y

te agradecemos anticipadamente por tus futuras colaboraciones.

Este es el grupo de trabajo para la traducción de la

documentación oficial de Python al Español, todo el contenido de la traducción

es mantenido por voluntaries que aportan su tiempo y trabajo a la comunidad.

Antes de comenzar tu primera traducción, y que sigas con esta guia de

contribución, queremos señalar algunos lineamientos generales.

- Esta traducción es mantenida por personas de todo el mundo que hablan el

idioma Español. No queremos atarla a ninguna región en particular y creemos

que es un valor extra la diversidad de la misma. Vas a encontrar secciones

con diferentes tonalidades de países, regiones o estilos. Lo único que pedimos

es consistencia dentro de un mismo módulo o sección (es decir no cambiar de

estilo de un párrafo a otro, por ejemplo) y siempre intentar que la persona del

otro lado pueda entender lo que estamos escribiendo (no usar lunfardo o

regionalismos muy propios de un único lugar).

- La documentación es ENORME, cualquier traba que encuentres siempre puedes

marcar el texto como “fuzzy” o para revisar en el futuro.

No pierdas horas buscando la palabra perfecta.

- En muchos casos el mejor criterio es pensar en el vocabulario que utilizamos

cuando le explicamos a otra persona, o en el trabajo. En muchas ocasiones la

versión en inglés o “spanglish” de la palabra es mucho mejor que decir “git

unir” (para git merge).

- Siempre vas a tener un review de lo que propongas y en ese intercambio otras

personas van a ayudarte a destrabar las dudas que tengas.

- Colaborar haciendo reviews también es muy muy importante, así que si

tienes un rato libre puedes comenzar por mirar los PRs pendientes de revisar.

- Último pero no menos importante, divertite y contá con la ayuda de todes. Te

esperamos en nuestro chat en telegram. ¡Gracias!

..note::

Si tienes cualquier duda, puedes enviarnos un email a docs-es@python.org.

¡Comienza a traducir!

#. Crea un fork delrepositorio_.

..note::

#. Agrega el repositorio original como "upstream"::

#. Crea una rama nueva en base al artículo en el que vayas a trabajar.

Por ejemplo, si vas a trabajar en el archivo ``glosario.po``, usa un nombre similar a::

#. Crea una rama nueva en base al artículo en el que vayas a trabajar. Por

ejemplo, si vas a trabajar en el archivo ``glosario.po``, usa un nombre

similar a::

#. Una vez que hayas elegido el archivo, lo puedes abrir con el editorpoedit_ y empezar a traducir.

#. Una vez que hayas elegido el archivo, lo puedes abrir con el editorpoedit_ y

empezar a traducir.

#. Cuando hayas terminado tu sesión, debes guardar tus cambios y enviarlos a GitHub de nuevo::

#. Cuando hayas terminado tu sesión, debes guardar tus cambios y enviarlos a

GitHub de nuevo::

#. No olvides añadir tu nombre al archivo ``TRANSLATORS`` si no lo has hecho todavía.

Los nombres se encuentran ordenados alfabéticamente por apellido.

#. No olvides añadir tu nombre al archivo ``TRANSLATORS`` si no lo has hecho

todavía.Los nombres se encuentran ordenados alfabéticamente por apellido.

#. Luego ve a tu página de GitHub y propone hacer un *Pull Request*.

..note::

Puedes consultar la `ayuda oficial de GitHub para crear un Pull Request`_ si lo deseas.

Puedes consultar la `ayuda oficial de GitHub para crear un Pull Request`_

si lo deseas.

#. En la descripción de la *Pull Request* escribe ``Closes #<número de issue>``

(así se cierra automáticamente cuando se hace *merge*)

..note::

Si hace tiempo que venis trabajando en una traducción es importante

mantener actualizada tu copia local antes de realizar el *Pull Request**

¿Qué archivo traducir?

Tenemos una `lista de issues en GitHub`_ en dónde vamos coordinando el trabajo realizado para no traducir dos veces lo mismo.

El proceso para traducir un archivo es el siguiente:

Tenemos una `lista de issues en GitHub`_ en dónde vamos coordinando el trabajo

realizado para no traducir dos veces lo mismo. El proceso para traducir un

archivo es el siguiente:

#. Elige cualquier de los que *no están asignados* a otra persona.

* No debes traducir el contenido de ``:ref:...`` y ``:term:...``.

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

* Puedes revisar las:doc:`faq` para leer sobre problemas conocidos.

* Si traduces un título que es un link, por favor traduce el link también (por ejemplo un artículo a Wikipedia).

En caso de que no haya una traducción del artículo en Wikipedia deja el título sin traducir.

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

* Si tienes una duda sobre una palabra o término, escríbelo como mejor suene para vos y

marca ese párrafo como "Need work" / "Necesita trabajo" en *poedit*.

Además, escribe un comentario explicando cuál es el termino en ese párrafo con el que no estabas segura.

* Puedes usar `la traducción al Portugués`_ para ver cómo ellos hicieron la traducción de alguna palabra.

* Wikipedia puede ser útil también. Busca la palabra en Inglés, y luego mira si tiene una traducción

al Español en la barra de la izquierda. Suelen estar bastante bien explicados.

* Si tienes que usar palabras en inglés debes ponerlas en *italics* (rodeadas

por asteriscos)

También puedes unirte a `nuestro canal de Telegram`_ si necesitas ayuda.

* Si traduces un título que es un link, por favor traduce el link también (por

ejemplo un artículo a Wikipedia). En caso de que no haya una traducción del

artículo en Wikipedia deja el título sin traducir.

* Tenemos una `Memoria de Traducción`_, que usamos para tener consistencia con

algunos términos.

Previsualizar los cambios

* Si tienes una duda sobre una palabra o término, escríbelo como mejor suene

para vos y marca ese párrafo como "Need work" / "Necesita trabajo" en

*poedit*. Además, escribe un comentario explicando cuál es el termino en ese

párrafo con el que no estabas segura.

Hay dos formas de visualizar, junto con el resultado final de la documentación, los cambios que has hecho.

* Puedes usar `la traducción al Portugués`_ para ver cómo ellos hicieron la

traducción de alguna palabra.

Read the Docs

* Wikipedia puede ser útil también. Busca la palabra en Inglés, y luego mira si

tiene una traducción al Español en la barra de la izquierda. Suelen estar

bastante bien explicados.

* Te recomendamos abrir una Pull Request aunque sea en formato borrador (marcada

como draft) desde los primeros commits de la traducción de tu fichero. De esta

forma, puedes recibir feedback desde el principio que puedes aplicar al resto

de la traducción, y probar el build más a menudo.

Una vez que hayas hecho un Pull Request en GitHub, este mostrará al final de página una sección de "check".

Allí debería haber uno que diga ``docs/readthedocs.org:python-docs-es`` y al lado un link de "Details".

Construcción local

También puedes unirte a `nuestro canal de Telegram`_ si necesitas ayuda.

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

Previsualizar los cambios

Este comando demorará unos minutos y generará toda la documentación en formato HTML en tu computadora.

Una vez que hayas hecho un *Pull Request* en GitHub, este mostrará al final de página una sección de "check".

..figure::readthedocs-preview.png

Y luego accediendo a http://localhost:8000/

Haciendo click en ese link verás una versión de la documentación completa que incluirá todos tus cambios.

Tendrás que navegar hasta el archivo que hayas cambiado para ver cómo se visualiza luego del build.

.. _repositorio:https://github.com/PyCampES/python-docs-es

.. _ayuda oficial de GitHub:https://help.github.com/es/github/getting-started-with-github/fork-a-repo

.. _ayuda oficial de GitHub para crear un Pull Request:https://help.github.com/es/github/collaborating-with-issues-and-pull-requests/about-pull-requests

.. _repositorio:https://github.com/python/python-docs-es

.. _ayuda oficial de GitHub:

.. _ayuda oficial de GitHub para crear un Pull Request:

.. _poedit:https://poedit.net/

.. _nuestro canal de Telegram:https://t.me/python_docs_es

.. _Memoria de traducción:https://python-docs-es.readthedocs.io/page/translation-memory.html

.. _Memoria de traducción:

.. _la traducción al Portugués:https://docs.python.org/pt-br/3/

.. _lista de issues en GitHub:https://github.com/PyCampES/python-docs-es/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc

.. _lista de issues en GitHub:

Desactivar "Smart Quotes" y "Smart Dashes"

..tip::

Este comando te puede ayudar a cambiar todas las comillas::

¿Qué parte de ``:ref:`` debo traducir?

Si por cualquier motivo no está funcionando ``pre-commit`` y no te deja hacer *push* de tus cambios,

lo puedes desinstalar simplemente mediante: ``pre-commit uninstall``.

¿Cómo puedo hacer un *build* local de la documentación?

..note::

Necesitas un poco de conocimiento para instalar ``make`` en tu sistema operativo.

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

Este comando demorará unos minutos y generará toda la documentación en formato HTML en tu computadora.

Puedes ver el resultado con tu navegador de internet (Firefox, Chrome, etc) ejecutando::

Y luego accediendo a http://localhost:8000/

¿Tienen una lista de correo?

Sí.

No tiene mucho tráfico aún ya que estamos usando más el canal de Telegram por el momento.

Puedes suscribirte ingresando aquí_.

.. _aquí:https://mail.python.org/mailman3/lists/docs-es.python.org/

..note::

Esta lista se actualiza automáticamente cuando Pull Requests se *mergean* a la rama ``3.8``.

Estas listas se actualiza automáticamente cuando Pull Requests se *mergean* a la rama ``3.8``.

En progreso

Muestra los porcentajes completados por directorio y solo los archivos que no están al 100%.

..runblock::console

$ potodo --offline --path .

Completados

Lista todos los archivos con un porcentaje de traducción mayor al 90% (para contemplar los que tienen fuzzy).

..runblock::console

$ python scripts/completed_files.py