Re: [vhffs-dev] documentation

[Sylvain Rochet <gradator@xxxxxxxxxxxx>]

rou !,

On Wed, Sep 19, 2007 at 02:45:01PM -0400, Bruno Marmier wrote:
> Bonjour,
> 
> J'utilise Vhffs depuis quelques mois déjà, à ma plus grande
> satisfaction. Je constate que le point faible de Vhffs est la
> documention et je suis prêt à donner un coup de main, par exemple à
> réorganiser le wiki, faire quelque chose de plus clair et de plus complet.
> 
> donc faites-moi signe...

/me cligne des yeux
/me relit
/me relit encore
/me se pince
/me relit encore

Bon dieu, je ne reve pas !

Et bien sache que oui, ca manque fortement de documentation, entre 
TuxFamily et le developement de VHFFS il reste a peine le temps de faire 
des nuits completes.

Tu as du voir le VHFFS Book ecrit il y a un moment, le plus gros boulot 
concernerait sa reecriture quasi totale pour VHFFS 4.1, le tout dans un 
style un peu plus correct que celui ecrit par le precedent mainteneur de 
VHFFS, et bien sur en Anglais si possible (pas forcement bien ecrit, du 
broken English convient a tout le monde). Donc ca c'est pour la partie 
Administrateur et c'est a mon sens le plus important.

La documentation utilisateur est quasi complete sur la FAQ[1] de 
TuxFamily, elle pourrait faire l'objet d'une documentation generique 
pour les utilisateurs de VHFFS mais c'est plutot difficile etant donne
que chaque admin fait un peu ce qu'il veut de VHFFS.

Ensuite, du cote developpeur, l'API devrait etre entierement documente 
via perldoc, c'est en toute petite partie fait, mais loin d'etre finit 
et plutot vide pour le moment :)

Quoi qu'il en soit, tu peux joindre le channel #vhffs sur 
irc.tuxfamily.org pour voir plus en detail le gros boulot necessaire sur 
la documentation ;)


[1] http://faq.tuxfamily.org/

Attachment: signature.asc
Description: Digital signature