La poule ou l'oeuf

Magnum 8
Du côté de Mandriva

 
Doc4Mandriva, la doc des paquetages
Stéphane Laurière
2009-11-20 / 2009-11-21


Pages :   1    2 
De nombreuses composantes font l'identité et le succès d'une distribution Linux, parmi lesquelles sa facilité d'utilisation, sa qualité technique, la taille et le dynamisme de sa communauté, son identité visuelle, l'efficacité de sa plateforme de production, mais aussi sans aucun doute la qualité de sa documentation. Dans l'objectif d'améliorer la documentation Mandriva, et afin de compléter le wiki Mandriva existant par une description détaillée de l'ensemble des paquetages inclus dans la distribution, une nouvelle plateforme communautaire, Doc4 Mandriva, a été mise en place à l'adresse http://doc4.mandriva.org.

Vers une documentation Mandriva unifiée et collaborative

Doc4 fournit une description détaillée de l'ensemble des applications et des paquetages inclus dans les distributions Mandriva.
Doc4 vise à répondre au problème de la fragmentation de la documentation Linux et à devenir un point d'accès central à l'ensemble des informations relatives aux paquetages Mandriva :informations d'utilisation, informations techniques, métriques de production et suivi du cycle de vie. Les données associées à chaque application et à chaque paquetage peuvent être enrichies de façon collaborative.
La page d'accueil du portail donne accès au contenu de chaque distribution Mandriva majeure, et aux derniers paquetages disponibles. La navigation peut ensuite s'effectuer par distribution, par groupe d'applications ou par accès direct aux applications ou aux paquetages.

Agrandir
La page d'accueil de Doc4 Mandriva
La fiche descriptive d'une application comporte quatre onglets (voir illustration page suivante):
L'onglet Overview présente la description générale de l'application, son site Web et sa licence ;
l'onglet Wiki pointe vers une page wiki destinée à recueillir commentaires ;
Trucs et astuces, captures d'écran, liens vers des tutoriels et autres enrichissements apportés par la communauté Mandriva ;
L'onglet Packages liste l'historique des paquetages sources et binaires de l'application ;
L'onglet Bugs présente les bugs Mandriva et Debian de l'application.

Agrandir
Page descriptive d’une application

Agrandir
L'édition de la description détaillée de l'application peut s'effectuer en mode WYSIWYG avec une ergonomie proche de celle de Google Docs.
Un clic sur un élément de l'onglet Packages conduit à la liste des paquetages disponibles pour cette application, pour les différentes distributions couvertes par le système, en paquetage source ou binaire. Un clic sur un paquetage binaire conduit à la fiche de description d'un paquetage, qui comporte les parties suivantes:
Overview: description générale du paquetage: taille, version, section, branche, date et machine de production
Dependencies: liste des différents types de dépendances du paquet (provides, requires, conflicts, obsoletes, suggests), avec des hyperliens vers une page de recherche permettant d'accéder aux paquets qui fournissent ou utilisent les dépendances listées
Scripts: programmes exécutés lors des phases de pré/post-installation et de pré/post-désinstallation,
Files: cette partie contient 4 sous-onglets (Chacun des fichiers peut être consulté en ligne depuis Doc4, ou bien téléchargé).:
All(X) présente sous forme d'un tableau l'ensemble des fichiers du paquetage, y compris les fichiers contenus dans des archives compressées. Le X indique le nombre de fichiers pour cet onglet ;
Configuration montre uniquement les fichiers de configuration ;
Documentation montre les fichiers de documentation ;
Translation permet d'accéder à tous les fichiers de traduction.
Changelog: historique des modifications apportées au paquetage.

Agrandir
Visualisation des fichiers contenus dans un paquetage

Agrandir
Consultation d'un fichier

Les prochaines étapes: vers une documentation 4.0

Doc4 Mandriva se prononce "Doc for Mandriva", faisant référence à la fois au fait que la plateforme est destinée aux distributions Mandriva et au contexte de l'évolution du Web et des systèmes d'information en général: Web 2, Web 3, Web 4 etc. Le Web 2 est communément le Web social collaboratif, le Web 3 celui des données interconnectées, et le Web 4 se caractérise notamment par l'extension du Web collaboratif des données à l'ensemble des appareils connectés - ordinateurs personnels, smartphones, capteurs, voitures, etc. C'est en référence à cette vision à long terme d'un Web 4 qui repose sur des mécanismes d'échanges de connaissances plus nombreux et plus puissants que s'inscrit l'initiative Doc4: échanges de connaissances en temps réel entre le serveur Doc4 et la multitude d'ordinateurs personnels et d'appareils communiquant capables de transmettre des informations pertinentes dans le contexte d'une documentation avancée de la distribution dans ses nombreux contextes d'utilisation.
Le développement de Doc4 s'effectue dans le cadre des projets de recherche collaboratifs Helios et Scribo soutenus par la région Ile-de-France et par la Direction Générale de la Compétitivité, de l'Industrie et des Services (DGCIS), et labellisés par le pôle de compétitivité francilien System@tic. Les prochaines améliorations que nous prévoyons d'apporter à Doc4 concernent en particulier le multilinguisme de l'application, l'ajout de fonctions d'annotation collaborative des contenus, l'utilisation d'un vocabulaire dédié à la description des applications, l'ajout semi-automatique de liens entre éléments de la documentation pour une navigation facilitée, et des fonctions de recherche dans l'intégralité des fichiers texte de la distribution. Par ailleurs, des fonctions de réseau social et de collaboration en temps-réel vont enrichir la plateforme dans le courant de l'année 2010 via le projet Wiki 3.0 qui réunit XWiki, Mandriva et l'INRIA et qui a été retenu par la DGCIS dans l'appel à projets Web innovant du volet numérique du plan de relance du gouvernement. Les développements futurs reposeront également directement sur les besoins que la communauté exprimera. A plus moyen terme, le projet pourrait évoluer vers la création d'une sorte de méta système d'information des distributions Linux, dans l'optique de davantage mutualiser le traitement des patchs, des bugs et des descripteurs de paquetages.

L'infrastructure

Doc4 repose d'une part sur un outil d'analyse qui extrait en continu les métadonnées et les fichiers des paquetages produits par Mandriva, d'autre part sur une application Web implémentée sur la plateforme collaborative 2.0 XWiki. L'outil d'extraction, d'analyse et de stockage est écrit en Python et est disponible sous licence GPL dans l'arborescence Subversion des Mandriva Labs.
L'application Web de présentation des données des paquetages et de collaboration autour de ces données est une application XWiki LGPL, XWiki Doc4, regroupant un plugin XWiki écrit en Java et un ensemble de gabarits de présentation, disponibles également dans le dépôt Subversion des Mandriva Labs. L'architecture à plugins d'XWiki permet à ceux qui le souhaitent de développer des extensions de Doc4. A titre d'exemple, un plugin d'affichage des données d'installabilité des packages (qui repose sur les données produites par l'outil rpmcheck) et un plugin de représentation visuelle des dépendances de paquets sont en cours de développement. Par ailleurs, l'API REST d'XWiki permettra dans un proche avenir d'exposer l'intégralité des données Doc4 en consultation et en édition sous forme de services Web.

Contribuez!

Bien que Doc4 soit encore en version beta, la plateforme peut dés à présent recueillir vos contributions: nous vous invitons en particulier à ajouter des descriptions, des captures d'écrans, des liens et tout autre élément utile à la découverte d'applications comme au perfectionnement dans leur utilisation, pour le bénéfice de l'ensemble de la communauté. Quant aux dysfonctionnements de la plateforme, ils peuvent être signalés directement via le site http://qa.mandriva.com. Les idées d'amélioration peuvent elles aussi être proposées via le site qa.mandriva.com ou via la liste Cooker.

Discussion :  1  

Discussion :  1  
Pages :   1    2 

Administrateur du livre

Licence CCbySA2+

RSS  Poule ou l'oeuf

One minute, please...
Fermer