Communauté Francophone de la Supervision Libre » Nagios Documentation

Version beta 6 de la documentation francophone

Olivier Jan — Mon, 15 Feb 2010 16:17:48 +0000

Je viens de mettre en ligne les deux nouvelles versions (pdf et html) beta 6 de la documentation francophone pour Nagios version 3.x

Cette version fait suite à la version beta 5 qui aura duré deux mois. Outre le travail de corrections de la documentation qui a été accompli, les points les plus notables pour cette version viennent de la version html qui devient une version xhtml; qui ne valide pas encore tout à fait xhtml 1.1 mais s’en approche Mais surtout, a fur et à mesure de nos progrès dans la manipulation du format docbook, c’est un tout nouveau confort de lecture pour cette version html qui est au rendez-vous puisque les pages sont désormais découpées en chapitres et non plus en sections.. Fini les urls avec du « ch1s02.html » et place à du plus explicite « gettingstarted-monitoring-windows.html » . Cette nouvelle version est également CSS ready, ce qui devrait nous permettre de modifier facilement le rendu de cette documentation au format xhml. Elle devient donc exploitable pour ceux qui ne voudraient pas télécharger l’excellent pdf Merci à tous les contributeurs de cette nouvelle version.

Version beta 5 de la documentation française

Olivier Jan — Sun, 06 Dec 2009 10:49:18 +0000

Le chemin pour arriver à une documentation française de qualité pour Nagios se poursuit avec la beta 5 de celle-ci et la correction de nombreuses erreurs, fautes mais aussi quelques nouveautés comme le glossaire et l’index qui font leur apparition. Merci à tout ceux qui s’impliquent dans ce projet d’utilité publique

Version française de la documentation Nagios 3.x

Olivier Jan — Wed, 07 Oct 2009 07:37:55 +0000

C’est fait. Nous venons de sortir la première version de la documentation française pour Nagios 3.x. Tout a commencé par un appel à volontaires dans la communauté.

Petit historique du projet

Transformation DocBook

Le travail a commencé en octobre 2008 avec la transformation de la version originale anglaise HTML de la documentation au format docbook. Avec le recul, ce choix s’est révélé intéressant pour pouvoir gérer cette traduction à plusieurs et suivre l’ensemble des modifications apportées. Ce format, standard dans la rédaction technique de documentation, nous permet aujourd’hui d’avoir une base nous permettant de générer à la fois un document PDF pour l’impression et une version HTML en ligne beaucoup plus propre d’un point de vue sémantique que la version de départ. Ce travail, qui a duré deux mois a été réalisé par

Sébastien Guilbaud
Olivier Jan

Traduction française

Ensuite est venu à proprement parlé le travail de traduction qui s’est étalé sur 9 mois environ et a mobilisé une équipe de cinq personnes dont voici les noms par ordre d’entrée en scène (vu du côté svn :

Olivier Jan
David Guénault
Dimitri Druelle
Guillaume Halbitte
Romuald Fronteau

À venir, la suite…

Relecture de la traduction

C’est donc la fin d’un travail d’un an qui s’achève pour laisser place à la phase de relecture. C’est le moment de remercier l’ensemble des personnes citées plus haut et de préparer la phase suivante de relecture. Nous ouvrons un forum dédié qui permettra aux 400 membres recensés actuellement dans les forums de pouvoir remonter tout problème de traduction, d’orthographe, de syntaxe et j’en passe. Ce qui n’empêche pas toute personne volontaire de se porter candidat « officiel » à la relecture.

Où trouver la documentation ?

Nous avons ouvert un site dédié aux documentations francophones sur Nagios et son écosystème. Il est le point de départ pour trouver l’ensemble des versions disponibles de la documentation française Nagios 3.x.
Le code source de la documentation au format XML Docbook peut quant à lui être trouvé comme à l’accoutumée sur la forge nagios-fr.org

Point sur la traduction de la documentation

Olivier Jan — Mon, 03 Nov 2008 06:50:42 +0000

Il y a bientôt un mois que j’ai lancé l’idée de reprendre la documentation de Nagios en français et c’est donc naturellement le moment de faire le point sur cette initiative.

Nous sommes désormais quatre dans l’équipe de traduction. Le travail de traduction n’a pas encore commencé à proprement parlé mais le cadre est désormais posé. Le premier travail qui touche tranquillement à sa fin est le passage de la documentation anglaise 3.0 au format Docbook XML. Ce document sera proposé comme source de la documentation à Ethan dès que cette étape sera achevée. Je l’ai déjà contacté sur le principe du maintien de la documentation au format docbook et j’attends sa réponse. Le code est géré dans un dépôt subversion et il vous est proposé un site qui vous permet de suivre les avancées du projet de traduction et de signaler toute erreur ou problème sur celle-ci. Vous trouverez également sur ce site le quickstart anglais au format pdf généré à partir du nouveau format source XML. Il donne une rendu assez fidèle de ce que sera la documentation française finale.

Vu la vitesse d’avancement du projet, il est possible de pouvoir compter sur un premier document de travail en français pour les fêtes de fin d’année. Vous pourrez offrir le manuel de Nagios 3 en français à votre sysadmin préfére pour Noël

Documentation française de Nagios: Feuille de route

Olivier Jan — Sun, 12 Oct 2008 09:09:30 +0000

J’ai décidé de reprendre la traduction de la documentation française de Nagios pour le compte de nagios-fr.org. Comme l’a montré le récent sondage, cet élément paraît primordial pour la communauté et c’est l’occasion de lancer un premier chantier pour nagios-fr.org. Les bonnes volontés sont les bienvenus et voici la feuille de route qui attend les volontaires.

Reprise de la documentation existante

Nettoyage du code source HTML et validation de celui-ci au format XHTML strict.
Corrections typographiques, orthographe, grammaire et sémantique.
Publication d’une version finale au format docbook, html et pdf.

Le premier point est d’ores et déjà réalisé. J’ai fini la validation XHTML de l’ensemble de la documentation existante qui peut désormais être trouvée à ce format sur nagios-fr.org. Il faut maintenant relire cette documentation et me rapporter toute erreur typographiques, orthographe, grammaire ou sémantique. Ce travail est un travail préparatoire à la génération de l’ensemble de cette documentation au format docbook. Il doit permettre une meilleure structuration de la documentation, en préparation à sa mise à jour en version 3. Le format docbook permet ensuite d’obtenir une version pdf de qualité. Une première version pdf convertie avec htmldoc à partir des sources XHTML se trouve sur nagios-fr.org en attendant la version finale. Cette première phase devrait pouvoir être menée à bien pour la fin de l’année.
La version de htmldoc utilisée pour la conversion vers le pdf est la dernière version 1.9 qui n’est pas encore finalisée. Son support du jeu de caractères utf-8 est plus qu’imparfaite; ce qui explique les erreurs sur ceux-ci encore présentes dans le document rendu. Mais après tout, c’est quand même la première version de la documentation française de Nagios au format pdf .

Mise à jour vers la version 3

En tenant compte de l’expérience accumulée avec le travail sur la version 2.x du document, cette phase permettra d’arriver à une version française de la documentation de Nagios 3 qui pourra être facilement manipuler sous plusieurs formats d’édition comme Open Office, PDF, HTML et autres.

Chaîne éditoriale envisagée

La traduction collaborative serait faite dans un wiki de type moinmoin parce que celui-ci sait exporter au format docbook. J’ai bien essayé sans trop de succès (très difficile de valider le moindre xml) docbook wiki qui paraissait pourtant le mieux adapter à la chose. Le wiki reste un moyen de publication intéressant ne serait-ce que parce qu’il gère nativement les versions et différences entre celles-ci. Il faudrait mettre en place un SVN pour avoir le même genre de services dans le cas où le document de base serait travailler directement en format docbook. Le problème de ce format est qu’il ne semble pas y avoir un éditeur gratuit digne de ce nom permettant de ne pas avoir à connaître les balises docbook. XXE paraît la seule alternative plausible pour le moment mais n’est pas vraiment facile d’accès malgré tout.
Le problème qu’il reste à traiter est la transformation de XHTML vers docbook qui est loin d’être parfaite quelque soit l’outil utilisée et nécessite pas mal de reprise à la main pour aboutir à un code XML tirant parti de la puissance de docbook. Il faut y voir mon intérêt actuel pour des langages de balisages léger type txt2tags ou RestructuredText et les outils de transformation type dblatex, pandoc ou xmlto. Je continue à investiguer et accepte toute idée concernant ce type de problématique.

L’équipe de traducteurs

Une petite équipe de traducteurs motivés est en train de se constituer. Nous sommes à priori déjà trois et il reste encore de la place pour les personnes motivées, alors n’hésitez pas…