diff --git a/.overrides/CONTRIBUTING.rst b/.overrides/CONTRIBUTING.rst index 263222d160..7fa80c0e44 100644 --- a/.overrides/CONTRIBUTING.rst +++ b/.overrides/CONTRIBUTING.rst @@ -17,12 +17,18 @@ contribución, queremos señalar algunos .. note:: Si tienes cualquier duda, puedes enviarnos un email a docs-es@python.org. - + También puedes unirte a `nuestro canal de Telegram`_ si necesitas ayuda. +El proceso general de traducción son tres pasos, de los cuales el primero tendrás que +realizar solo una vez. Te los detallamos a continuación. -Antes de comenzar ------------------ + +Paso 0: Configuración de Github +------------------------------- + +Esta configuración la tienes que realizar sólo una vez, y con ello +podrás realizar todas las contribuciones que quieras. #. Para enviar una traducción, necesitas tener un **fork** del repositorio_ oficial, haciendo click en el botón encerrado en rojo. @@ -62,10 +68,26 @@ Antes de comenzar ``powrap`` y ``pospell`` para poder verificar tus archivos traducidos, y también construir la documentación localmente. -¡Comienza a traducir! ---------------------- +.. _que-archivo-traducir: + +Paso 1: ¿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: -#. Selecciona un :ref:`archivo para traducir `. + +#. Elige cualquiera de los issues que *no están asignados* a otra persona. +#. Deja un comentario en el issue diciendo que quieres trabajar en él. +#. Espera a que un administrador te asigne el issue. +#. ¡Empieza a traducir! + + +Paso 2: ¡Comienza a traducir! +----------------------------- + +#. Tener un :ref:`archivo asignado para traducir `. #. Verifica que estás en la rama principal del repositorio, **3.11** (esto es muy importante para evitar crear una nueva rama a partir de una traducción @@ -74,20 +96,52 @@ Antes de comenzar git checkout 3.11 #. Crea una rama nueva en base al artículo en el que vayas a trabajar. Por - ejemplo, si vas a trabajar en el archivo ``library/glosario.po``, usa un nombre + ejemplo, si vas a trabajar en el archivo ``library/ast.po``, usa un nombre similar a:: - git checkout -b traduccion-glosario + git checkout -b traduccion-ast #. Una vez que hayas elegido el archivo, lo puedes abrir con el editor poedit_ y empezar a traducir. +#. **Formato de columnas**: Si utilizas poedit_ es posible que tu archivo tenga + la estructura adecuada, pero te invitamos a comprobarlo con la herramienta + powrap_, la cual puedes instalar y utilizar por la línea de comandos. + Ejecuta:: + + powrap /tu_archivo.po + + Recuerda que tu archivo puede estar dentro de un ````, como + ``library``, con lo que tendrás que ejecutar el comando ``powrap + library/tu_archivo.po`` si no te encuentras en el mismo directorio de tu + archivo. + + .. note:: Si estás en Windows y tienes problemas, mira los comentarios de + :ref:`powrap_windows` para más información. + +#. **Corrección ortográfica**: Para verificar la ortografía de tu archivo + puedes utilizar la herramienta pospell_ para que verifiques que todas las + palabras están aceptadas o incluidas en diccionarios. Para ello tenemos + un script de conveniencia que puedes utilizar:: + + python scripts/check_spell.py /tu_archivo.po + + Si alguna palabra no es reconocida, y es una palabra válida, tienes que + agregarla al diccionario correspondiente en el directorio dictionaries/. + Busca el archivo que corresponde al que estás traduciendo y si no existe, créalo. + Por ejemplo el diccionario del archivo ``library/ast.po`` se encuentra en + ``dictionaries/library_ast.po``. + + .. note:: Si estás en Windows y tienes problemas, mira los comentarios de + :ref:`pospell_windows` para más información. + #. Cuando hayas terminado tu sesión, debes guardar tus cambios y enviarlos a - GitHub (No olvides añadir tu nombre al archivo ``TRANSLATORS``):: + GitHub (No olvides añadir tu nombre al archivo ``TRANSLATORS``). + Si estuvieras trabajando en el archivo ``library/ast.po`` los pasos serían:: - git add library/glosario.po - git commit -m 'Traducido archivo library/glosario' - git push origin traduccion-glosario + git add library/ast.po + git commit -m 'Traducido archivo library/ast' + git push origin traduccion-ast .. note:: @@ -107,22 +161,6 @@ Antes de comenzar :ref:`mantener actualizada ` tu copia local antes de realizar el *Pull Request*. -.. _que-archivo-traducir: - -¿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: - - -#. Elige cualquiera de los issues que *no están asignados* a otra persona. -#. Deja un comentario en el issue diciendo que quieres trabajar en él. -#. Espera a que un administrador te asigne el issue. -#. ¡Empieza a traducir! - - .. _a-tener-en-cuenta: A tener en cuenta @@ -203,9 +241,9 @@ Memoria de traducción --------------------- Tenemos una :doc:`Memoria de Traducción `, que usamos para tener consistencia con algunos -términos. +términos. Si tienes alguna duda respecto a cómo traducir alguna palabra no te olvides de revisar este contenido. -Del mismo modo, si luego de trabajar sobre un término *complicado* llegas a un acuerdo con otros colaboradores: +Del mismo modo, si luego de trabajar sobre un término *complicado* llegas a un acuerdo con otros colaboradores: no se olviden de agregarlo. @@ -215,6 +253,8 @@ no se olviden de agregarlo. .. _ayuda oficial de GitHub para crear un Pull Request: https://help.github.com/es/github/collaborating-with-issues-and-pull-requests/about-pull-requests .. _poedit: https://poedit.net/ +.. _powrap: https://github.com/AFPy/powrap +.. _pospell: https://github.com/AFPy/pospell .. _nuestro canal de Telegram: https://t.me/python_docs_es .. _la traducción al Portugués: https://docs.python.org/pt-br/3/ diff --git a/.overrides/faq.rst b/.overrides/faq.rst index 71d653c1b7..6318210c05 100644 --- a/.overrides/faq.rst +++ b/.overrides/faq.rst @@ -246,3 +246,48 @@ No tiene mucho tráfico aún ya que estamos usando más el canal de Telegram por Puedes suscribirte ingresando aquí_. .. _aquí: https://mail.python.org/mailman3/lists/docs-es.python.org/ + +.. _powrap_windows: + +Utilizar ``powrap`` en Windows +------------------------------ + +Si no estás usando MinGW o el Subsistema de Linux en Windows como entorno +de trabajo, la única opción que tienes es utilizar la herramienta ``poedit`` +para traducir y ajustar el largo de cada línea. + +Si vas a *Preferences -> Advanced* podrás encontrar una forma de seleccionar +que los *Line endings* sean *Unix (recommended)* y que la opción **Wrap +at** esté activada y tenga el valor **70**. + +La razón de estos problemas, es que ``powrap`` utiliza una dependencia +llamada ``msgcat`` que provee el paquete ``gettext`` que usualmente +se puede instalar en macOS y Linux, pero no en Windows. + +.. _pospell_windows: + +Utilizar ``pospell`` en Windows +------------------------------- + +La herramienta ``pospell`` depende de un paquete llamado ``hunspell``, y que no +se instala por defecto mediante ``pip``. Para instalar la dependencia tienes +dos opciones: + +#. Utilizar el paquete que provee una iniciativa llamada + *exwinports*, que puedes seleccionar desde esta + `lista de archivos `_. + Luego descomprimes el archivo en algún lugar como ``C:\hunspell\``, + y agregas dicho directorio al ``PATH``:: + + set PATH=C:\hunspell\bin;%PATH% + + y finalmente, descarga un diccionario ``es_ES`` de algún lugar, + por ejemplo, de `acá `_. +#. Utilizar el subsistema Linux, y configurar todo desde dicho sistema, + clonando el repositorio y todo desde ahí. Luego ejecutas la instalación + de ``pospell`` (via pip) y ``hunspell`` (via apt-get) para utilizar + las herramientas desde ahí. + + .. note:: Tendrás que tener todo configurado en el subsistema Linux para + poder utilizar esta opción. +