1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
Ubuntu en la educación : Un proyecto de ubuntu-mx
-------------------------------------------------
https://launchpad.net/ubuntu-mx-temario-escuelas
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:
https://wiki.ubuntu.com/UbuntuMxTeam/Membresia#Obtener_una_cuenta_en_Launchpad
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:
$ bzr whoami "Juan Lopez <juan.lopez@gmail.com>"
$ bzr launchpad-login su_nick_en_launchpad
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)
http://docutils.sourceforge.net/docs/user/rst/quickstart.html
http://docutils.sourceforge.net/docs/user/rst/quickref.html
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.
Problemas, comentarios y sugerencias
------------------------------------
Si tiene algún, problema, comentario o sugerencia, envielo a:
Bugs - https://bugs.launchpad.net/ubuntu-mx-temario-escuelas
Preguntas - https://answers.launchpad.net/ubuntu-mx
O entre y pregunte directamente en #ubuntu-mx (freenode):
http://webchat.freenode.net/?channels=ubuntu-mx
Licencia
--------
Este proyecto esta licenciado bajo la CC-BY-SA-3.0, el texto completo puede
verse en el archivo COPYING.
|