Skip site navigation (1) Skip section navigation (2)

Proyecto de Documentación de FreeBSD: Enviando Documentación

He escrito algunos documentos, como los envío?

Ante todo, gracias por ocupar tu tiempo en hacerlo.

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 ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming/, y usa send-pr para comunicar a los "committers" que está disponible.

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.

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 FreeBSD-current y FreeBSD-stable.

Una vez la gente haya visto tu documento y hayas podido incorporar las posibles sugerencias que te hayan hecho, estás preparado para enviarlo.

Para hacerlo, compacta el/los documentos en un fichero tar. Si tu documentación consta de 3 ficheros, uno, dos y tres, y quieres compactarlos en el fichero doc.tar, haz

    % tar cf doc.tar one two three
    

Una vez hecho, comprime el fichero tar,

    % gzip -9 doc.tar
    

creando el fichero doc.tar.gz.

A continuación envía el fichero doc.tar.gz ( obviamente, ponle un nombre más indicativo del contenido pero siempre manteniendo la extensión tar.gz) a ftp.freebsd.org, en el directorio /pub/FreeBSD/incoming/.

Ahora tienes que comunicar al proyecto de documentación la existencia del fichero. La manera correcta de hacerlo es usar un comando llamado send-pr, el cual debería estar instalado en tu máquina.

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.

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!

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.

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.

Alternativamente, puedes usar un interface web en http://www.freebsd.org/send-pr.html.

He hecho algunos cambios a documentación ya existente. Como la envío?

De nuevo, gracias por ocuparte de ello.

Lo primero que tienes que hacer es crear un fichero especial llamado diff. Este fichero mostrará única y exclusivamente las modificaciones realizadas sobre la documentación original.

Para hacer un "diff" tienes que;

  1. Hacer una copia del fichero que vas a modificar. Si estás cambiando el fichero foo.xml, haz

        % cp foo.xml foo.xml.old
    	
  2. Entonces, haz los cambios en el fichero foo.xml

        % vi foo.xml
        ... tap tap tap ...
    
        ... testea los cambios, leelos y revisalos...
    	
  3. Haz el diff. El comando para hacerlo es

        % diff -c foo.xml.old foo.xml > foo.diff
    	

    Este comando buscará las diferencias entre los dis ficheros escribiendolas en el fichero foo.diff.

Ya puedes enviar el fichero foo.diff al proyecto.

También puedes enviar el fichero foo.diff a ftp://ftp.FreeBSD.ORG /pub/FreeBSD/incoming/ o, si es muy pqueño, incluir el diff directamente en el PR, en la sección "Fix:"

De cualquier manera, usarás el comando send-pr 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).

FreeBSD Documentation Project Home