diff --git a/fr/docproj/doc-set.sgml b/fr/docproj/doc-set.sgml index 19f4a582f3..96fff08354 100644 --- a/fr/docproj/doc-set.sgml +++ b/fr/docproj/doc-set.sgml @@ -1,53 +1,53 @@ - + %includes; ]> &header;

La documentation de FreeBSD est composée de trois grandes catégories :

  1. Les pages de manuel

    Le Projet n'est pas réellement concerné car elles font partie du système de base. Exception faite de l'équipe japonaise qui les traduit. Il n'y a pas de raisons que d'autres volontaires ne se mettent pas à traduire les pages de manuel dans d'autres langues.

    Cela ne veut pas dire que les pages de manuel ne sont pas importantes, loin de là. C'est juste qu'elles sont intimement liées aux systèmes spécifiques à FreeBSD et que la plupart du temps la personne la mieux placée pour les écrire est le développeur lui-même.

  2. Les livres

    Le projet a un grand nombre de documentations qui sont de la taille d'un livre ou qui sont conçues comme un livre. C'est par exemple le cas de la FAQ FreeBSD et du Manuel de Référence FreeBSD.

  3. Les articles

    FreeBSD a une mine d'informations disponibles sous formes d'articles plus courts -- à la manière des guides ou des HOWTO d'autres projets.

Accueil du Projet de Documentation FreeBSD -&footer +&footer; diff --git a/fr/docproj/docproj.sgml b/fr/docproj/docproj.sgml index 71905c0b8c..09d4d0903b 100644 --- a/fr/docproj/docproj.sgml +++ b/fr/docproj/docproj.sgml @@ -1,90 +1,90 @@ - + %includes; ]> &header;

Vue d'ensemble

S'attaquer à un système d'exploitation nouveau et complexe est toujours une tâche difficile, quelque soit sa convivialité. FreeBSD n'est pas différent à cet égard.

Il existe de nombreux livres sur les Unix BSD (et les &unix; en général) mais FreeBSD possède ses propres caractéristiques, procédures et bizarreries.

De plus, FreeBSD est amené à être le premier contact avec un système d'exploitation dérivé d'Unix pour beacoup d'utilisateurs donc la disponiblité d'une documentation précise et de haute qualité est indispensable.

Le Projet de Documentation FreeBSD est là pour combler ce vide. Il s'y prend de deux façons :

  1. Les membres du Projet de Documentation écrivent un document et le soumettent afin qu'il soit inclu dans le Jeu de Documentation FreeBSD.

  2. Les membres du Projet de Documentation débatent de la forme et de l'organisation du Jeu de Documentation FreeBSD.

Projets en cours

Plusieurs projets sont actuellement en cours de réalisation dans le cadre de l'effort de documentation. Prenez le temps de consulter cette liste afin de savoir s'il y en a un pour lequel vous pouvez apporter de l'aide.

Qui sommes-nous, comment nous rejoindre

Cette page explique qui compose le Projet de Documentation et comment s'y joindre.

Le Jeu de Documentation FreeBSD

Cette page esquisse la composition du Jeu de Documentation FreeBSD ainsi que le travail que le Projet de Documentation réalise.

SGML et le Projet de Documentation

Le projet essaie d'utiliser le SGML pour la documentation. Cette page survole la méthode utilisée et dirige les lecteurs intéressés vers davantage de ressources SGML.

Proposer une documentation

Les propositions de documentation sont le meilleur moyen de faire partie du projet et de rendre FreeBSD plus facile à utiliser. Cette page décrit la meilleure façon de soumettre un document afin qu'il soit examiné le plus rapidement possible.

Traduction

Traductions de la documentation FreeBSD : pages web, manuel de référence, pages de manuel et FAQ.

- &footer + &footer; diff --git a/fr/docproj/handbook3.sgml b/fr/docproj/handbook3.sgml index bd9b2368e0..18e8d6ac45 100644 --- a/fr/docproj/handbook3.sgml +++ b/fr/docproj/handbook3.sgml @@ -1,236 +1,236 @@ - + %developers; %includes; Fait"> En progrès"> Pas commencé"> ]> &header;

Manuel de référence FreeBSD 3ème Edition

La 3ème édition du Manuel de référence FreeBSD sera publiée en 2 volumes, chacun de plus de 400 pages. Le volume I (Guide de l'Utilisateur) couvrira les bases, tandis que le volume II (Guide de l'administrateur) couvrira l'administration système et des sujets plus avancés.

Si vous voulez participer à la production de cette édition, vous pouvez envoyer un courrier électronique à la liste de diffusion -doc. Merci !

- + - + - +
TâcheResponsableDernière mise à jourStatut
Ajouter un attribut "type" aux URLs locales de manière à ce qu'elles puissent être omises dans la version imprimée. &a.murray; 18 Mai 2003 &done;
Ajouter des <colspecs> aux tables pour améliorer la sortie imprimée. &a.murray; 18 Mai 2003 &inprogress;
Supprimer tous les dessins ASCII &a.murray; 18 Mai 2003 &done;
Mettre à jour le chapitre sur l'utilisation des versions récentes de GNOME &a.marcus; 18 Mai 2003 &done;
Corriger les tags de références croisées pour améliorer la sortie imprimée. &a.murray; 18 Mai 2003 &inprogress;
"Standardiser" les termes techniques &a.trhodes; 18 Mai 2003 &inprogress;
S'assurer que tous les noms de fichiers, les commandes, les applications, les noms d'hôtes, etc sont correctement marqués &a.blackend; 18 Mai 2003 &inprogress;
Mettre à jour l'appendice des auteurs ayant participés. &a.chern; 18 Mai 2003 ¬started;
Mettre à jour le chapitre sur PPP/SLIP &a.trhodes; 18 Mai 2003 &done;
Remettre en ordre la section IPSec &a.hmp;, &a.chern; 26 Octobre 2003 &done;
Ajouter des illustrations simples au début de chaque partie.   18 Mai 2003 ¬started;
Ajouter des graphiques pour les Notes, les Avis, les Avertissements et les Astuces. &a.hrs; 18 Mai 2003 &inprogress;
Concevoir la couverture.   18 Mai 2003 ¬started;
Mettre à jour l'introduction du chapitre consacré aux versions postérieures à la 5.0.   18 Mai 2003 ¬started;
Améliorer la présentation de l'entrée en matière &a.murray; 18 Mai 2003 &done;
Corriger les erreurs grammaticales. Tout le monde ! 18 Mai 2003 &inprogress;
Mettre en place un correcteur orthographique automatisé. Chern a écrit plusieurs scripts Tcl et les a postés sur la liste doc@ lors des travaux sur la seconde édition. Cela pourrait être un bon point de départ.   18 Mai 2003 ¬started;
S'assurer que tous les titres de section sont en capitales &a.ceri; 18 Mai 2003 &done;
Supprimer les sections Questions/Réponses superflues en faveur d'un texte plus formel. (voir la fin du chapitre ports/paquetages) &a.trhodes; 18 Mai 2003 &inprogress;
Ajouter des informations à propos de l'ACPI. &a.trhodes; et &a.njl; 18 Mai 2003¬started;&inprogress;
Ajouter des informations à propos de Kerberos5 et corriger les informations sur Kerberos4 en tenant compte de ces ajouts. &a.trhodes; 18 Mai 2003 &done;
Mettre à jour la préface. &a.murray; 18 Mai 2003 &inprogress;
Ecrire l'avant-propos.   18 Mai 2003 ¬started;
Mettre à jour la bibliographie avec les nouvelles éditions, etc.&a.ceri;  18 Mai 2003 ¬started;
Ajouter des références à l'index à travers tout le livre. Réorganiser certains termes indexés existants. Voir la fonction "make indexcheck" pour trouver les endroits du livre où les termes indexés sont trop peu nombreux.   18 Mai 2003 ¬started;
Ecrire une introdution pour le chapitre sur les communications séries (remarquez le commentaire "XXX - Ecrivez-moi !"). Le synopsis actuel peut probablement servir de base.   19 Mai 2003 ¬started;
La section "mini-cartouche" dans le chapitre sur les disques reste toujours à écrire.   22 Mai 2003 ¬started;
Ajouter des informations sur la configuration réseau dans le chapitre consacré à l'installation. &a.trhodes; 18 Mai 2003 &done;
Ajouter de la documentation sur cron(8). &a.trhodes; 18 Mai 2003 &done;
Envoyer le tout à l'imprimeur. &a.murray;   ¬started;
diff --git a/fr/docproj/submitting.sgml b/fr/docproj/submitting.sgml index ef40d0433b..27113c7904 100644 --- a/fr/docproj/submitting.sgml +++ b/fr/docproj/submitting.sgml @@ -1,141 +1,141 @@ - + %includes; ]> &header;

Je viens d'écrire de la documentation. Comment puis-je la soumettre ?

Avant tout, merci d'avoir pris le temps de le faire.

Vous devez rendre votre documentation accessible aux relecteurs. Si vous le pouvez, mettez votre travail sur un site FTP ou web.

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.

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.

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 FreeBSD-current et FreeBSD-stable

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.

Pour ceci, faites-en un fichier tar. Si votre documentation est composée de trois fichiers un, deux, et trois, et que vous voulez tout regrouper dans doc.tar, tapez :

     % tar cf doc.tar un deux trois

dont c'est précisément le rôle. Puis compressez le fichier tar,

     % gzip -9 doc.tar

qui produira doc.tar.gz.

Enfin, encodez le fichier de façon à ce qu'il ne soit pas modifié par les logiciels de courrier électronique.

     % uuencode doc.tar.gz doc.tar.gz > doc.uue

Vous devez ensuite en informer le Projet de Documentation. La manière correcte de le faire est d'utiliser la commande send-pr, qui devrait être installée sur votre machine.

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.

send-pr 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 send-pr, vous serez amené à rédiger un message à partir de votre éditeur (vraisemblalement vi ou emacs) avec quelques instructions sur cette étape.

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 .uue que vous avez créé précédemment dans le PR.

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.

J'ai procédé à quelques changements sur une documentation existante, comment puis-je les soumettre ?

Encore une fois, nous vous remercions d'avoir pris le temps de faire ceci.

Premièrement, vous devez produire un fichier spécifique, appelé diff. 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).

Pour faire un "diff", vous devez :

  1. Faire une copie du fichier que vous allez modifier. Si vous modifiez foo.sgml, tapez

         % cp foo.sgml foo.sgml.old

  2. Puis, procédez à vos modifications sur foo.sgml.

         % vi foo.sgml
     ... tap tap tap ...
 
     ... testez les changements, relisez pour corriger les coquilles, etc...

  3. Faites le diff. La commande est la suivante :

         % diff -ru foo.sgml.old foo.sgml > foo.diff

    Ceci repère les différences entre les deux fichiers, et les écrit dans le fichier foo.diff.

Vous pouvez maintenant envoyer foo.diff au projet. Envoyez un PR comme décrit plus haut et n'oubliez pas d'inclure le fichier foo.diff dans le corps du PR.

Projet de Documentation FreeBSD : Accueil -&footer +&footer;