From 8135722f2d62d6a94f1a0546aae3a0adf83543f9 Mon Sep 17 00:00:00 2001 From: gilgamezh Date: Sun, 24 May 2020 19:54:43 +0200 Subject: [PATCH 1/2] welcome intro draft --- .overrides/CONTRIBUTING.rst | 145 ++++++++++++++++++++++++------------ 1 file changed, 99 insertions(+), 46 deletions(-) diff --git a/.overrides/CONTRIBUTING.rst b/.overrides/CONTRIBUTING.rst index 12438542e7..7b50321b6e 100644 --- a/.overrides/CONTRIBUTING.rst +++ b/.overrides/CONTRIBUTING.rst @@ -1,10 +1,47 @@ :orphan: -Guía para contribuir en la traducción +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 “fuzzi” 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:: @@ -29,60 +66,67 @@ Necesitamos *mucho* de tu ayuda para poder seguir adelante con este proyecto. git remote add upstream https://github.com/python/python-docs-es.git -#. 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:: git checkout -b traduccion-glosario -#. Una vez que hayas elegido el archivo, lo puedes abrir con el editor poedit_ y empezar a traducir. +#. Una vez que hayas elegido el archivo, lo puedes abrir con el editor poedit_ 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:: - git commit -am 'Traducido archivo {nombre de archivo}' - git push origin traduccion-glosario + git commit -am 'Traducido archivo {nombre de archivo}' git push origin + traduccion-glosario -#. 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 #`` (así se cierra automáticamente cuando se hace *merge*) -¿Qué 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: +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. -#. Deja un comentario en el issue diciendo que quieres trabajar en él. -#. Espera a que un administrador te asigne el issue. -#. ¡Empieza a traducir! +#. Elige cualquier de los 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 ----------------- -* 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. +* 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. .. note:: @@ -90,28 +134,33 @@ A tener en cuenta También puedes unirte a `nuestro canal de Telegram`_ si necesitas ayuda. -Previsualizar los cambios +Previsualizar los cambios ------------------------- -Hay dos formas de visualizar, junto con el resultado final de la documentación, los cambios que has hecho. +Hay dos formas de visualizar, junto con el resultado final de la documentación, +los cambios que has hecho. -Read the Docs +Read the Docs ````````````` -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". +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". -Haciendo click en ese link verás una versión de la documentación con tus cambios. +Haciendo click en ese link verás una versión de la documentación con tus +cambios. -Construcción local +Construcción local `````````````````` -Desde el mismo directorio ``python-docs-es/`` que se creó cuando hiciste ``git clone`` puedes ejecutar:: +Desde el mismo directorio ``python-docs-es/`` que se creó cuando hiciste ``git +clone`` puedes ejecutar:: make build -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:: +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:: make serve @@ -119,11 +168,15 @@ Y luego accediendo a http://localhost:8000/ .. _repositorio: https://github.com/python/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 +.. _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 .. _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: + https://python-docs-es.readthedocs.io/page/translation-memory.html .. _la traducción al Portugués: https://docs.python.org/pt-br/3/ -.. _lista de issues en GitHub: https://github.com/python/python-docs-es/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+no%3Aassignee+translate +.. _lista de issues en GitHub: + https://github.com/python/python-docs-es/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+no%3Aassignee+translate From 90a4ae4632d4e71979f277105e1245747e84d6f1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicol=C3=A1s=20Demarchi?= Date: Sun, 24 May 2020 21:29:44 +0200 Subject: [PATCH 2/2] Update .overrides/CONTRIBUTING.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Claudia Millán --- .overrides/CONTRIBUTING.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.overrides/CONTRIBUTING.rst b/.overrides/CONTRIBUTING.rst index 7b50321b6e..cd2df8a0d4 100644 --- a/.overrides/CONTRIBUTING.rst +++ b/.overrides/CONTRIBUTING.rst @@ -25,7 +25,7 @@ contribución queremos señalar algunos lineamientos generales. regionalismos muy propios de un único lugar) - La documentación es ENORME, cualquier traba que encuentres siempre puedes - marcar el texto como “fuzzi” o para revisar en el futuro. + 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