From 0de6369aead3716ca8a98bd691f54a567031bcad Mon Sep 17 00:00:00 2001 From: Tomas Zulberti Date: Thu, 19 Mar 2020 20:59:24 -0300 Subject: [PATCH 1/2] =?UTF-8?q?ISSUE-64:=20Se=20actualizo=20la=20informaci?= =?UTF-8?q?=C3=B3n=20de=20como=20colaborar?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.rst | 3 + pages/colaborandoenelwiki.rst | 194 ++++++++++------------------------ 2 files changed, 57 insertions(+), 140 deletions(-) diff --git a/README.rst b/README.rst index 2bd354c4f..043445fb4 100644 --- a/README.rst +++ b/README.rst @@ -7,6 +7,9 @@ sincronizará automáticamente con la wiki una vez que sea mezclado. Antes de clonar el repo, asegurate de tener instalado [Git LFS][https://git-lfs.github.com/] +Pueden ver como colaborar en la pagina de `Como colaborar +`__ + Como buildear las paginas ========================= diff --git a/pages/colaborandoenelwiki.rst b/pages/colaborandoenelwiki.rst index 7a1d378b9..8a59ebe91 100644 --- a/pages/colaborandoenelwiki.rst +++ b/pages/colaborandoenelwiki.rst @@ -1,171 +1,85 @@ Como colaborar en el Wiki de Pyar ================================= -.. todo:: Sacar esto de moin-moin y poner lo que corresponda -Primeros Pasos -~~~~~~~~~~~~~~ +.. contents:: + :local: - * Registrarse en el wiki! - * Completar tu pagina personal (es opcional pero muy recomendado) - * Si no queres responder 500 veces de que color es el caballo blanco de san martín podes pedirle a algun admin, o en la lista, que te agregen al ReadWriteGroup +Introducción +------------ -Colaborando con Código -~~~~~~~~~~~~~~~~~~~~~~ +Existen varias maneras de contribuir con la wiki de Python Argentina: -* Podes agregar tus recetas en el [[Recetario | Recetario]] +- reportando bugs, +- revisando que esos bugs se encuentren vigentes, +- etc, -Tenemos Instalado Pygments, asi que podes colorear tu codigo con: -:: +No importa como colaboran, siempre se tiene que seguir el `Codigo de +Conducta `__ - #!code moin - {{{ - #!code python - print "Hola Mundo" - }}} +Reportanto Bugs +--------------- -Y queda: +Cuando se reporte un bug, lo ideal sería que el mismo tenga: -:: +- El link de donde se encuentra el error +- Una captura de pantalla de que es lo que está mal +- Un mensaje describiendo el error que se quiere cambiar - {{{ - #!code python - print "Hola Mundo" - }}} -Ademas de colorear python, colorea el lenguaje que quieras... incluso java +Proponiendo una mejora +---------------------- -Como agregar mails de forma un poco mas segura -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Hay dos formas de proponer mejoras: -Cuando Agregamos direcciones de mail conviene usar el macro MailTo, que evita que los mails queden en plano en el wiki (cuando ponemos mails que no son nuestros) +- Hacer un cambio en una página puntual desde GitHub. +- Haciendo un Pull request +En cualquier caso, siempre es necesario que se creen una cuenta en +`GitHub `__ -:: +Sino saben mucho de reStructuredText, estos son algunos links que les pueden +ayudar: - {{{ - #!code moin - <> - }}} +- `Wikipedia reStructeredText `__ +- `rST Syntax `__ +- `Create Documentation with RST, Sphinx, Sublime, and GitHub `__ -Y queda: -<> +Cambio puntual +++++++++++++++ -Mas Funcionalidades Copadas -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Si estas viendo una pagina que esta mal, a la derecha del título +hay un link a Editar que los va a llevar al código fuente de todas +paginas -Mapas -+++++ +Una vez en la misma, pueden editarla desde el mismo Github, +y cuando commiten los cambios va a pedir crear un Pull request. -:: +Cambios masivos ++++++++++++++++ - {{{ - #!code moin - <> - }}} +Si tienen que hacer cambios masivos, por ahi usar la interfaz de +Github para editar todos los archivos es ineficiente. +En ese caso: - <> +- Tienen que hacer un fork del proyecto +- Clonarse el fork +- Lean el README.rst para saber como configurar el entorno local +- Editar todos los cambios que crean necesarios +- Hacer un pull requests de su fork al proyecto oficial -Twitter -+++++++ +Cosas a tener en cuenta +----------------------- -:: +Cuando estas editando páginas rST, un par de cosas a tener en cuenta: - {{{ - #!code moin - <> - }}} - - <> - -Restructured Text -+++++++++++++++++ - -:: - - {{{{ - #!code moin - {{{ - #!rst - - ======================== - Restructured Text - ======================== - - Otro Título - =========== - **Algo En Negrita** - }}} - }}}} - {{{ - #!rst - - ======================== - Restructured Text - ======================== - - Otro Título - =========== - **Algo En Negrita** - - }}} - -Video HTML 5 -++++++++++++ - -:: - - {{{ - #! moin - <> - }}} - <> - -Figuras -+++++++ - -:: - - {{{{ - !#code moin - {{{#!aafig aspect=0.5 scale=2 - ddddddddd - dd ddddddddd - ddddddddddddd - ddddddddddddd - dddddddddddddddddddd eeeeee - dddddddddddddddddddd eeeeeee - dddddddd eeeeeeee - ddddddd eeeeeeeeeeeeeeeeeeee - dddddd eeeeeeeeeeeeeeeeeee - eeeeeeeeeeeee - eeeeeeeeeeeee - eeeeeeeee ee - eeeeeeeeee - - }}} - - }}}} - - - {{{#!aafig aspect=0.5 scale=2 - - ddddddddd - dd ddddddddd - ddddddddddddd - ddddddddddddd - dddddddddddddddddddd eeeeee - dddddddddddddddddddd eeeeeee - dddddddd eeeeeeee - ddddddd eeeeeeeeeeeeeeeeeeee - dddddd eeeeeeeeeeeeeeeeeee - eeeeeeeeeeeee - eeeeeeeeeeeee - eeeeeeeee ee - eeeeeeeeee - - }}} +- Los archivos tienen que tener los nombres en minúscula y no tener tildes + ni otros caracteres especiales +- Los archivos tienen que tener extensión ``.rst`` +- Cuando tengan que poner una dirección de mail, no pongan la direccion del mail + real, `foobar@example.com`, sino que usen palabras como `dot, at`. Por ejemplo: + `foobar at example dot com` From 0d3eb07ba3d010364f4e2d29f0090a5e70b68d5a Mon Sep 17 00:00:00 2001 From: Tomas Zulberti Date: Wed, 25 Mar 2020 18:08:06 -0300 Subject: [PATCH 2/2] ISSUE-64: Se agrego el link a lo issues de Githb --- pages/colaborandoenelwiki.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/colaborandoenelwiki.rst b/pages/colaborandoenelwiki.rst index 8a59ebe91..bb7afff99 100644 --- a/pages/colaborandoenelwiki.rst +++ b/pages/colaborandoenelwiki.rst @@ -10,7 +10,7 @@ Introducción Existen varias maneras de contribuir con la wiki de Python Argentina: -- reportando bugs, +- `reportando bugs `__, - revisando que esos bugs se encuentren vigentes, - etc,