30e164bba6
1.12 -> 1.13 fr/docproj/doc-set.sgml 1.16 -> 1.17 fr/docproj/docproj.sgml 1.26 -> 1.28 fr/docproj/handbook3.sgml 1.13 -> 1.14 fr/docproj/submitting.sgml
141 lines
6.2 KiB
Text
141 lines
6.2 KiB
Text
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" [
|
|
<!ENTITY base CDATA "..">
|
|
<!ENTITY enbase "../&base;">
|
|
<!ENTITY date "$FreeBSD: www/fr/docproj/submitting.sgml,v 1.4 2004/01/06 17:31:40 stephane Exp $">
|
|
<!ENTITY title "Projet de documentation FreeBSD : Proposer de la documentation">
|
|
<!ENTITY % includes SYSTEM "../includes.sgml"> %includes;
|
|
]>
|
|
|
|
<!--
|
|
The FreeBSD French Documentation Project
|
|
Original revision: 1.14
|
|
|
|
Version francaise : Thomas Seyrat
|
|
Version francaise (mise a jour) : Stephane Legrand <stephane@freebsd-fr.org>
|
|
Version francaise (mise a jour) : Vincent Tougait <viny@scientiae.net>
|
|
-->
|
|
|
|
<html>
|
|
&header;
|
|
|
|
<h2>Je viens d'écrire de la documentation. Comment puis-je la soumettre ?</h2>
|
|
|
|
<p>Avant tout, merci d'avoir pris le temps de le faire.</p>
|
|
|
|
<p>Vous devez rendre votre documentation accessible aux relecteurs. Si vous le pouvez,
|
|
mettez votre travail sur un site FTP ou web.</p>
|
|
|
|
<p>Enfin, postez un message dans la liste de diffusion -doc, accompagné d'un
|
|
bref descriptif de la documentation et d'un lien vers elle, tout en sollicitant
|
|
des réactions.</p>
|
|
|
|
<p>Si, pour une raison ou pour une autre, vous ne pouvez pas mettre votre documentation sur un site FTP ou sur
|
|
un site web, vous pouvez l'envoyer directement sur la liste de diffusion -doc.
|
|
Si vous le faites, merci d'envoyer uniquement des documents au format texte simple.</p>
|
|
|
|
<p>Vous devriez probablement envoyer une copie du message aux autres listes de diffusion
|
|
concernées. Par exemple, une documentation traitant de l'utilisation de CVSup pour
|
|
garder votre hiérarchie de code source à jour intéressera les
|
|
abonnés aux listes de diffusion <tt>FreeBSD-current</tt> et
|
|
<tt>FreeBSD-stable</tt></p>
|
|
|
|
<p>Une fois votre documentation examinée par les abonnés, et que vous aurez
|
|
le cas échéant incorporé les suggestions que vous jugerez bonnes,
|
|
vous pouvez la soumettre à examen.</p>
|
|
|
|
<p>Pour ceci, faites-en un fichier tar. Si votre documentation est composée de
|
|
trois fichiers <tt>un</tt>, <tt>deux</tt>, et <tt>trois</tt>, et que vous voulez tout
|
|
regrouper dans <tt>doc.tar</tt>, tapez :</p>
|
|
|
|
<pre>
|
|
% <b>tar cf doc.tar un deux trois</b>
|
|
</pre>
|
|
|
|
<p>dont c'est précisément le rôle. Puis compressez le fichier tar,</p>
|
|
|
|
<pre>
|
|
% <b>gzip -9 doc.tar</b>
|
|
</pre>
|
|
|
|
<p>qui produira <tt>doc.tar.gz</tt>.</p>
|
|
|
|
<p>Enfin, encodez le fichier de façon à ce qu'il ne soit pas modifié
|
|
par les logiciels de courrier électronique.</p>
|
|
|
|
<pre>
|
|
% <b>uuencode doc.tar.gz doc.tar.gz > doc.uue</b>
|
|
</pre>
|
|
|
|
<p>Vous devez ensuite en informer le Projet de Documentation. La manière correcte
|
|
de le faire est d'utiliser la commande <b>send-pr</b>, qui devrait être installée
|
|
sur votre machine.</p>
|
|
|
|
<p>Procédez ainsi afin que votre requête puisse être enregistrée. Lorsque vous
|
|
soumettez un PR (Problem Report), un numéro unique lui est attribué. L'un des
|
|
responsables peut ainsi s'attribuer la requête PR, et assurer la liaison avec
|
|
vous dans l'optique d'intégrer la nouvelle documentation.</p>
|
|
|
|
<p><b>send-pr</b> en lui-même est plutôt simple. Tout ce qu'il fait est d'envoyer
|
|
un message électronique dans un formatage adapté à une adresse
|
|
particulière. Lorsque vous lancez <b>send-pr</b>, vous serez amené à
|
|
rédiger un message à partir de votre éditeur (vraisemblalement <b>vi</b> ou
|
|
<b>emacs</b>) avec quelques instructions sur cette étape.</p>
|
|
|
|
<p>Assurez-vous que "Category" est bien sur "docs" et que "Class" est sur
|
|
l'un des "change-request". Et n'oubliez pas d'inclure le fichier <tt>.uue</tt>
|
|
que vous avez créé précédemment dans le PR.</p>
|
|
|
|
<p>Lorsque vous sortirez de l'éditeur, le PR sera expédié
|
|
électroniquement au bon endroit. Vous recevrez peu après un accusé de
|
|
réception accompagné du numéro attribué à votre PR,
|
|
permettant de suivre l'évolution du travail. </p>
|
|
|
|
<h2>J'ai procédé à quelques changements sur une documentation existante, comment puis-je
|
|
les soumettre ?</h2>
|
|
|
|
<p>Encore une fois, nous vous remercions d'avoir pris le temps de faire ceci.</p>
|
|
|
|
<p>Premièrement, vous devez produire un fichier spécifique, appelé <i>diff</i>.
|
|
Ce fichier diff montre simplement les changements que vous avez faits. Ceci rend
|
|
le travail du responsable plus aisé, afin de voir précisément ce que vous avez
|
|
changé, et permet de vous éviter de perdre beaucoup de temps à l'expliquer (bien
|
|
que vous devriez tout de même expliquer pourquoi vous avez jugé que les changements
|
|
devaient être faits).</p>
|
|
|
|
<p>Pour faire un "diff", vous devez :</p>
|
|
|
|
<ol>
|
|
<li><p>Faire une copie du fichier que vous allez modifier. Si vous
|
|
modifiez <tt>foo.sgml</tt>, tapez</p>
|
|
|
|
<pre>
|
|
% <b>cp foo.sgml foo.sgml.old</b>
|
|
</pre></li>
|
|
|
|
<li><p>Puis, procédez à vos modifications sur foo.sgml.</p>
|
|
|
|
<pre>
|
|
% <b>vi foo.sgml</b>
|
|
... tap tap tap ...
|
|
|
|
... testez les changements, relisez pour corriger les coquilles, etc...
|
|
</pre></li>
|
|
|
|
<li><p>Faites le diff. La commande est la suivante :</p>
|
|
|
|
<pre>
|
|
% <b>diff -ru foo.sgml.old foo.sgml > foo.diff</b>
|
|
</pre>
|
|
|
|
<p>Ceci repère les différences entre les deux fichiers, et les écrit dans le
|
|
fichier <tt>foo.diff</tt>.</p></li>
|
|
</ol>
|
|
|
|
<p>Vous pouvez maintenant envoyer <tt>foo.diff</tt> au projet. Envoyez un PR comme
|
|
décrit plus haut et n'oubliez pas d'inclure le fichier <tt>foo.diff</tt> dans le corps
|
|
du PR.</p>
|
|
|
|
<p></p><a href="docproj.html">Projet de Documentation FreeBSD : Accueil</a>
|
|
&footer;
|
|
</body>
|
|
</html>
|