documento

Como colaborar

Para la organización y desarrollo de este manual, se utilizaron las mismas herramientas que se usan para crear Ubuntu, por lo tanto requerirá:

1.- Una cuenta en http://launchpad.net

Puede encontrar una guía paso a paso sobre el proceso en:

2.- Ser parte del equipo de ubuntu-mx

Una vez tenga su cuenta en launchpad, puede ir a http://launchpad.net/~ubuntu-mx y hacer click en "Join the team" para ser parte del equipo.

3.- Generar una llave ssh y subirla a http://launchpad.net

La conexión que se hace entre su equipo y launchpad usa un tunel seguro de ssh. Para habilitar ese tunel, escriba en una terminal:

  • $ ssh-keygen #y de enter hasta que genere una llave

Suba a https://launchpad.net/~/+editsshkeys el contenido de su llave pública (aquella que termina en *.pub). Al finalizar este paso, tendrá acceso al repositorio y a los permisos necesarios para modificarla. Sea precavido al momento de hacerlos.

4.- Instalar las herramientas necesarias

Para descargar el código fuente y poder modificarlo, requerira algunos programas. En una terminal escriba:

  • $ sudo apt-get install -y apt-get install bzr doc-base python-sphinx $ sudo apt-get install -y texlive-fonts-recommended texlive-latex-extra

5.- Configurar las herramientas

Cuando haya terminado, habrá que configurar bzr para linkear su cuenta con bzr, en una terminal ejecute:

Utilice el mismo nombre y correo con el que se registró en launchpad.net

6.- Descargar el código fuente

  • $ bzr checkout lp:ubuntu-mx-temario-escuelas

Al ejecutar esta orden, se creará un directorio llamado 'ubuntu-mx-temario-escuelas', después de ello estará listo para comenzar a editar.

7.- "Compilar" el código fuente

Para la creación de esta guía se ha utilizado sphinx (http://sphinx.pocoo.org) una poderosa herramienta de documentación. Sphinx permite crear un archivo 'master' y generar diferentes formatos a partir del mismo, html, páginas man, pdf, latex, txt, etc.

Puede consultar una página de referencia en las siguientes direcciones (le ayudará a editar de mejor forma la guía)

Para esta guía el formato de referencia será el PDF:

  • $ cd ubuntu-mx-temario-escuelas $ make pdf

Esto le generará un archivo *.pdf en el directorio _build/, cada vez que modifique la guía y antes de hacer commit, deberá correr $ make pdf para asegurarse que el manual se sigue compilando sin errores.

8.- 9.- 10.-

8.- Edición

Ahora puede empezar a hacer sus cambios, entre a 'ubuntu-mx-temario-escuelas' y haga los cambios que crea pertinentes, siga la guía de estilo (disponible debajo de esta sección), cuando este feliz con el resultado y haya verificado que la nueva versión se ve bien:

  • $ make pdf

Agregue los archivos que haya modificado, ejemplo: si ha modificado el archivo 'README', en una terminal escriba:

  • $ bzr add README

Si ha olvidado cuales archivos ha modificado puede usar la orden: $ bzr status

9.- Commit

Al hacer commit, sus cambios se enviaran a ubuntu-mx y todos nos podremos beneficiar de una mejor guía, en una terminal escriba:

  • $ bzr commit -m "se agregó información sobre xxx cosa"

Intente describir sus cambios tan claros como sea posible

10.- Mantener su repositorio al día

Utilice:

  • $ bzr update

Por lo menos una vez al día para sincronizar sus cambios con los del equipos. Para aprender más sobre bzr vea el siguiente link: https://help.launchpad.net/Code/TeamBranches

11.- Agregue su nombre y correo al archivo ubuntu-mx-temario-escuelas/contributors.rst

Descripción de las carpetas

debian/

  • Este directorio se utiliza para generar un paquete .deb a partir de la guía, a menos que sepa sobre empaquetamiento de software, querrá mantenerse alejado de el.

images/

  • En esta carpeta se guardan todas las imágenes en formato *.png|*.jpg, cada vez que agregué una utilice
    • $ bzr add img/su_imagen
    Vea el README de la sección para conocer como generar los archivos *.jpg

sources/

  • Este directorio sirve para guardar las imágenes fuente *.svg, si no sabe lo que es una imágen *.svg, puede perder cuidado de ella.

_static/ _templates/

  • Estas carpetas no se utilizan, pero se han dejado para no crear conflicto con sphinx

themes/

  • En este lugar se guarda el tema, si desea modificar el existente, no modifique 'ubuntu', haga una copia y haga sus modificaciones sobre el nuevo tema

ubuntu-mx-temario-escuelas/

  • Esta carpeta contiene el contenido de la guía en archivos *.rst, si agregá nuevos temas, además de utilizar $ bzr add, listelos en index.rst para que aparezcan en el índice de contenidos

Guía de estilo

A continuación se describen las reglas de estilo que deben tomarse en cuenta al momento de editar el manual:

* Mantenga la forma de narración

  • Segunda persona impersonal

* Evite hacer referencias a la terminal * Solo se haga referencias cuando desee agregar una sección de 'Truco' * Use un lenguaje enfocado a principiantes * En lugar de tablas o listas, use imágenes, intente usar tantas imágenes como sean posibles * Edite las imágenes para que concuerden con el resto * Prioritice contenido práctico sobre filosófico|teorico * Si considera que un sección teórica es necesaria, agreguela al apendice y use

  • referencias a ella

Las modificaciones a estas reglas deben ser discutidas con anterioridad, use launchpad o la lista de correo para sugerirlas.

SergioMeneses/sandbox/documento (last edited 2013-03-05 00:35:34 by adsl-201-185-249-37)