141 lines
5.7 KiB
Text
141 lines
5.7 KiB
Text
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN" [
|
|
<!ENTITY base CDATA "..">
|
|
<!ENTITY date "$FreeBSD$">
|
|
<!ENTITY title "Proyecto de Documentación de FreeBSD: Enviando Documentación">
|
|
<!ENTITY % includes SYSTEM "../includes.sgml"> %includes;
|
|
]>
|
|
<!-- $FreeBSD$ -->
|
|
|
|
<html>
|
|
&header;
|
|
|
|
<h2>He escrito algunos documentos, como los envío?</h2>
|
|
|
|
<p>Ante todo, gracias por ocupar tu tiempo en hacerlo.</p>
|
|
|
|
<p>Tendrías que poner los documentos disponibles para ser revisados
|
|
. Si puedes ponlos en un espacio FTP o Web. Si no tienes espacio
|
|
propio, envíalos a <a
|
|
href="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming/">ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming/</a>, y usa <b>send-pr</b> para comunicar a los
|
|
"committers" que está disponible.</p>
|
|
|
|
<p>A continuación envía un mensaje a la lista de
|
|
distribución freebsd-doc, con una breve descripción
|
|
y su localización. Pide opiniones.</p>
|
|
|
|
<p>También deberías enviar una copia del mensaje a otras
|
|
listas relacionadas. Por ejemplo, algo relativo al uso de CVSup para
|
|
mantener actualizado el código fuente, también sería
|
|
de interés para los subscriptores de las listas
|
|
<tt>FreeBSD-current</tt> y <tt>FreeBSD-stable</tt>.</p>
|
|
|
|
<p>Una vez la gente haya visto tu documento y hayas podido incorporar
|
|
las posibles sugerencias que te hayan hecho, estás preparado
|
|
para enviarlo.</p>
|
|
|
|
<p>Para hacerlo, compacta el/los documentos en un fichero tar. Si tu
|
|
documentación consta de 3 ficheros, <tt/uno/, <tt/dos/ y <tt/tres/,
|
|
y quieres compactarlos en el fichero <tt/doc.tar/, haz</p>
|
|
|
|
<pre>
|
|
% <b>tar cf doc.tar one two three</b>
|
|
</pre>
|
|
|
|
<p>Una vez hecho, comprime el fichero tar,</p>
|
|
|
|
<pre>
|
|
% <b>gzip -9 doc.tar</b>
|
|
</pre>
|
|
|
|
<p>creando el fichero <tt>doc.tar.gz</tt>.</p>
|
|
|
|
<p>A continuación envía el fichero <tt/doc.tar.gz/ (
|
|
obviamente, ponle un nombre más indicativo del contenido pero
|
|
siempre manteniendo la extensión <tt/tar.gz/) a
|
|
<tt/ftp.freebsd.org/, en el directorio
|
|
<tt>/pub/FreeBSD/incoming/</tt>.</p>
|
|
|
|
<p>Ahora tienes que comunicar al proyecto de documentación la
|
|
existencia del fichero. La manera correcta de hacerlo es usar un
|
|
comando llamado <b>send-pr</b>, el cual debería estar instalado
|
|
en tu máquina.</p>
|
|
|
|
<p>Tienes que hacer esto para que tu envío pueda ser controlado.
|
|
Cuando envías un PR (Problem Report) se le asigna un
|
|
número único. Así uno de los committers puede
|
|
asignarse el PR, y ponerse de acuerdo contigo para hacer el envío
|
|
final.</p>
|
|
|
|
<p>Make sure the "Category" is set to "docs" and that the "Class" is set
|
|
to one of "change-request". And do not forget to include the name of the
|
|
file that you uploaded, so that the committers can find it!</p>
|
|
<p>Asegúrate que el campo "Category" tiene como valor "docs" y que
|
|
el campo "Class" está en "change-request". No te olvides de
|
|
incluir el nombre del fichero que has enviado, para que el committer
|
|
pueda encontrarlo.</p>
|
|
|
|
<p>Cuando sales del editor, será enviado un mensaje de PR al
|
|
lugar correcto. En un corto periodo de tiempo recibirás un
|
|
mensaje de notificación indicandote el número de PR
|
|
asignado, pudiendo usar este número para hacer el seguimiento
|
|
del estado en que se encuentra.</p>
|
|
|
|
<p>Alternativamente, puedes usar un interface web en <a
|
|
href="http://www.freebsd.org/send-pr.html">http://www.freebsd.org/send-pr.html</a>.</p>
|
|
|
|
<h2>He hecho algunos cambios a documentación ya existente. Como
|
|
la envío?</h2>
|
|
|
|
<p>De nuevo, gracias por ocuparte de ello.</p>
|
|
|
|
<p>Lo primero que tienes que hacer es crear un fichero especial llamado
|
|
<i>diff</i>. Este fichero mostrará única y exclusivamente
|
|
las modificaciones realizadas sobre la documentación original.</p>
|
|
|
|
<p>Para hacer un "diff" tienes que;</p>
|
|
|
|
<ol>
|
|
<li><p>Hacer una copia del fichero que vas a modificar. Si estás
|
|
cambiando el fichero <tt/foo.sgml/, haz</p>
|
|
|
|
<pre>
|
|
% <b>cp foo.sgml foo.sgml.old</b>
|
|
</pre></li>
|
|
|
|
<li><p>Entonces, haz los cambios en el fichero foo.sgml</p>
|
|
|
|
<pre>
|
|
% <b>vi foo.sgml</b>
|
|
... tap tap tap ...
|
|
|
|
... testea los cambios, leelos y revisalos...
|
|
</pre></li>
|
|
|
|
<li><p>Haz el diff. El comando para hacerlo es</p>
|
|
|
|
<pre>
|
|
% <b>diff -c foo.sgml.old foo.sgml > foo.diff</b>
|
|
</pre>
|
|
|
|
<p>Este comando buscará las diferencias entre los dis ficheros
|
|
escribiendolas en el fichero <tt/foo.diff/.</p></li>
|
|
</ol>
|
|
|
|
<p>Ya puedes enviar el fichero <tt/foo.diff/ al proyecto.</p>
|
|
|
|
<p>También puedes enviar el fichero <tt/foo.diff/ a <a
|
|
href="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming/">ftp://ftp.FreeBSD.ORG
|
|
/pub/FreeBSD/incoming/</a> o, si es muy pqueño, incluir el diff
|
|
directamente en el PR, en la sección "Fix:"</p>
|
|
|
|
<p>De cualquier manera, usarás el comando <b>send-pr</b> para
|
|
hacer saber a los "committers" que se han producido modificaciones.
|
|
Asegúrate que el campo "Category" contiene "docs" y que el
|
|
campo "Class" es "doc-bug" (si tu cambio modifica algún error
|
|
ya existente) o "change-request" (si estás añadiendo
|
|
nueva información a una sección ya existente).</p>
|
|
|
|
<p></p><a href="docproj.html">FreeBSD Documentation Project Home</a>
|
|
&footer
|
|
</body>
|
|
</html>
|