Cooker Doc

AshLeDombos Membre non connecté
-
- Voir le profil du membre AshLeDombos
- Inscrit le : 11/05/2008
- Site internet

La qualité de ces docs me semble vraiment excellente

Le docbook de cookerdoc, ça ressemble à ça : http://svn.mandriva.com/cgi-bin/viewvc. ... threv=1410
Dites moi ce que vous en pensez

(PS cookerdoc n'a rien à voir avec cooker, hormis le nom

<a href="http://hodo.free.fr">
</a>


DaaX Membre non connecté
-
- Voir le profil du membre DaaX
- Inscrit le : 13/12/2007
- Site internet
Malheureusement je n'y étais samedi soir dernier mais ça m'intéresse néanmoins. Je suis inscrit actuellement à la mailing list concernant la doc et je vous jure que ça travaille fort (comment puis-je y contribuer d'ailleurs?) et effectivement la qualité y est. J'ai cependant quelques questionnements : est-ce qu'on va inclure de la documentation concernant kde4.1 et ne serait-il pas intéressant de connaître, avant d'installer, la configuration minimale pour installer Mandriva?
AshLeDombos :
...mais il manque une visibilité et aussi une possibilté d'importer facilement la doc dans un site (comme mlo ou mandatak) ou la possibilité de créer facilement du docbook pour ajouter des articles.
Ouais, effectivement il faudrait qu'on regarde cette possibilité Janot et moi. On te tient au courant s'il y a possibilité de faire quelque chose.


Janot Membre non connecté
-
- Voir le profil du membre Janot
- Inscrit le : 18/02/2007
- Site internet
- Groupes :
-
Fondateur MLO

Il est vrai que présenté de cette manière, cela n'a rien de vraiment attrayant.
On doit pouvoir arranger tout ça en rajoutant quelques graphismes...
Sinon pour ce qui est de sa qualité je n'ai pas vraiment encore regardé... Mais les sommaires ont l'air plutôt riche!
Par contre est elle à jour cette doc?
Personnellement et si cette doc en vaut le coup (ce dont je ne doute pas après ce que tu m'ai dit Ash) je peux essayer d'y apporter mon aide...
Mais je suis lancé déjà dans pleins de projets en parallèle ce qui ne simplifie pas toujours ma vie...

Pour ce qui est de la visibilité de la doc, sur MLO nous pourrions la mettre plus en avant sur le portail...
Par contre cela n'a d'intérêt que si nous travaillons dessus à son amélioration afin de donner aux gens envie de la lire...
Donc perso, je pense qu'il faut absolument travailler sa présentation voire peut être même la mettre au format PDF ou tout autre format transportable connu.


AshLeDombos Membre non connecté
-
- Voir le profil du membre AshLeDombos
- Inscrit le : 11/05/2008
- Site internet

Pour répondre à Daax et Janot : la doc 2009 sera le plus complet possible et complètement à jour

Ce qui manque c'est une accessibilité un outil joli et pratique pour trouver et explorer cette super doc, et un outil pour générer facilement des articles supplémentaires.
J'ai parlé de vous à Camille de Cooker-doc car je pense que MLO/mandatak et Cooker doc ont tous les deux vocations à faire une doc accessible, complète et exemplaire

<a href="http://hodo.free.fr">
</a>


Janot Membre non connecté
-
- Voir le profil du membre Janot
- Inscrit le : 18/02/2007
- Site internet
- Groupes :
-
Fondateur MLO

Je pense que DaaX le sera aussi...
Par contre techniquement je ne vois pas bien comment mettre ça en place non plus...
Faut-il transformer ça en PDF?
Faut-il laisser ça au format HTML et revoir uniquement la présentation? Dans ce cas, alors l'insérer sur MLO serait tout à fait envisageable!

Qui peut (ou a le droit) de modifier cette doc? Seulement Mandriva?


AshLeDombos Membre non connecté
-
- Voir le profil du membre AshLeDombos
- Inscrit le : 11/05/2008
- Site internet
Janot :
Faut-il transformer ça en PDF?
Faut-il transformer ça en PDF?
Non non, en plus il n'y aurait pas d'intérêt réel. Je crois que c'est déjà fait, mais peut etre que l'asso mandrivafr pourrait voir comment diffuser la doc sous forme de livre (comme ubuntu facile) mais je ne pense pas que ça soit du ressort de mlo (me trompé-je ?)
Janot :
Faut-il laisser ça au format HTML et revoir uniquement la présentation? Dans ce cas, alors l'insérer sur MLO serait tout à fait envisageable!
Faut-il laisser ça au format HTML et revoir uniquement la présentation? Dans ce cas, alors l'insérer sur MLO serait tout à fait envisageable!

C'est ça, et plus encore

Comme le docbook c'est du xml, l'idée serait en gros de faire une documentation semi-dynamique
[list]
[*]une partie fixe contenant les articles de bases, séparés dans les 4 catégories de cooker-doc : Installer, démarrer, maîtriser et Drakxtools. Bien que ces articles soient figés, on pourrait noter et pour faciliter la recherche, avec possibilité d'ajouter des commentaires, d'exporter la page en pdf, de mettre en relation avec d'autres articles (genre : voir aussi ces articles en relation)[/*:m]
[*]Une partie dynamique, d'articles qui pourraient être créés, avec des formulaires adaptés pour créer les articles selon l'architecture imposée (un chapitre, du texte etc.), notés etc comme pour la partie statique, mais avec en plus une procédure de validation pour cooker-doc (c'est à dire qu'une fois qu'un article est jugé suffisamment mature pour entrer dans la doc officielle, il devient valide. On pourrait permettre aux gens de dire quand ils jugent qu'un article est suffisamment prêt pour faire partie du cooker doc officiel, être traduit etc.[/*:m][/list:u]
L'idée étant de visuellement séparer les différents types d'articles, de profiter de la superbe doc qu'est cooker doc, tout en permettant de continuer à créer de nouveaux articles, de nouvelles astuces etc.
Je pense que ça ne devrait pas être trop difficile (je parle de la conversion docbook<->site, pas du site lui même) car l'architecture de cooker doc est vraiment simplissime : chapitres>paragraphes>texte/liste/warning/note/astuce/code...
Janot :
Qui peut (ou a le droit) de modifier cette doc? Seulement Mandriva?
Qui peut (ou a le droit) de modifier cette doc? Seulement Mandriva?

C'est de l'OPL <a class="postlink" href="http://www.deficreation.com/modules.php?name=Encyclopedia&op=content&tid=505" onclick="window.open(this.href);return false;">http://www.deficreation.com/modules.php ... nt&tid=505</a>

</div>
<a href="http://hodo.free.fr">
</a>


Janot Membre non connecté
-
- Voir le profil du membre Janot
- Inscrit le : 18/02/2007
- Site internet
- Groupes :
-
Fondateur MLO
Si tel est le cas nous pourrions nous pencher sur la question.
Techniquement, nous avons de la place sur le serveur pour accueillir la doc une fois sa conversion en "HTML dynamique" terminée... Nous pourrions même créer un sous domaine du type: cookerdoc.mandrivalinux-online.eu (ou un truc du genre).
Par contre, je n'ai pas de connaissances en XML ce qui me bloque pour comprendre comment tansformer cette doc... Donc là je bloque...
Il faut aussi penser que chez MLO les mois qui viennent vont être très chargés car nous allons changer de serveur rapidement et que la 2009 va sortir...
Maintenant on doit pouvoir s'arranger pour bosser dessus assez rapidement!


DaaX Membre non connecté
-
- Voir le profil du membre DaaX
- Inscrit le : 13/12/2007
- Site internet

JAnot :
Personnellement je suis entièrement OK avec ta vision! 
Je pense que DaaX le sera aussi...

Je pense que DaaX le sera aussi...
Je suis absolument en accord avec cette vision.

AshLeDombos :
C'est ça, et plus encore
: il faudrait, je pense, recréer dynamiquement les pages html à partir du docbook.
Comme le docbook c'est du xml, l'idée serait en gros de faire une documentation semi-dynamique
* une partie fixe contenant les articles de bases, séparés dans les 4 catégories de cooker-doc : Installer, démarrer, maîtriser et Drakxtools. Bien que ces articles soient figés, on pourrait noter et pour faciliter la recherche, avec possibilité d'ajouter des commentaires, d'exporter la page en pdf, de mettre en relation avec d'autres articles (genre : voir aussi ces articles en relation)
* Une partie dynamique, d'articles qui pourraient être créés, avec des formulaires adaptés pour créer les articles selon l'architecture imposée (un chapitre, du texte etc.), notés etc comme pour la partie statique, mais avec en plus une procédure de validation pour cooker-doc (c'est à dire qu'une fois qu'un article est jugé suffisamment mature pour entrer dans la doc officielle, il devient valide. On pourrait permettre aux gens de dire quand ils jugent qu'un article est suffisamment prêt pour faire partie du cooker doc officiel, être traduit etc.

Comme le docbook c'est du xml, l'idée serait en gros de faire une documentation semi-dynamique
* une partie fixe contenant les articles de bases, séparés dans les 4 catégories de cooker-doc : Installer, démarrer, maîtriser et Drakxtools. Bien que ces articles soient figés, on pourrait noter et pour faciliter la recherche, avec possibilité d'ajouter des commentaires, d'exporter la page en pdf, de mettre en relation avec d'autres articles (genre : voir aussi ces articles en relation)
* Une partie dynamique, d'articles qui pourraient être créés, avec des formulaires adaptés pour créer les articles selon l'architecture imposée (un chapitre, du texte etc.), notés etc comme pour la partie statique, mais avec en plus une procédure de validation pour cooker-doc (c'est à dire qu'une fois qu'un article est jugé suffisamment mature pour entrer dans la doc officielle, il devient valide. On pourrait permettre aux gens de dire quand ils jugent qu'un article est suffisamment prêt pour faire partie du cooker doc officiel, être traduit etc.
Pour ma part, je connais bien le xml et afin de transformer des données xml en pages web, il faut lui appliquer un transformation xslt, c'est-à-dire une transformation à l'aide d'un template xsl. Le template récupère les données et les mets en forme afin de générer une page html. Donc, pour la partie fixe, ça peut le faire. Où ça demande un peu plus de travail, c'est la partie dynamique. Il faudrait voir comment il serait possible d'implémenter ça. Il pourrait peut-être existé quelque chose là-dessus, c'est à voir.

AshLeDombos Membre non connecté
-
- Voir le profil du membre AshLeDombos
- Inscrit le : 11/05/2008
- Site internet

Dîtes moi en quoi je peux aider : je peux travailler avec daax sur le xslt, ou bien encore aider janot pour différentes parties de la migration... Bien sûr, je ferais en fonction de ce qu'il m'est humainement possible de faire en terme de capacité, de temps, et de concordance avec la vie familiale, mais je pense que c'est notre cas à tous

<a href="http://hodo.free.fr">
</a>


DaaX Membre non connecté
-
- Voir le profil du membre DaaX
- Inscrit le : 13/12/2007
- Site internet
AshLeDombos :
Je suis heureux que le projet vous intéresse 
Dîtes moi en quoi je peux aider : je peux travailler avec daax sur le xslt, ou bien encore aider janot pour différentes parties de la migration...

Dîtes moi en quoi je peux aider : je peux travailler avec daax sur le xslt, ou bien encore aider janot pour différentes parties de la migration...
Salut Ash,
Laisse moi regarder ça avec Janot. Il faudra s'entendre sur une présentation pour cette doc et regarder la migration de tout ça. On te tient au jus sans faute et te solliciterai pour m'aider avec le xslt.

AshLeDombos :
Bien sûr, je ferais en fonction de ce qu'il m'est humainement possible de faire en terme de capacité, de temps, et de concordance avec la vie familiale, mais je pense que c'est notre cas à tous 

Effectivement, c'est notre cas.


Janot Membre non connecté
-
- Voir le profil du membre Janot
- Inscrit le : 18/02/2007
- Site internet
- Groupes :
-
Fondateur MLO

Par contre je ne te cacherai pas que pour l'instant ça n'est pas notre priorité... Loin de là.


DaaX Membre non connecté
-
- Voir le profil du membre DaaX
- Inscrit le : 13/12/2007
- Site internet
Janot :
Bein cette doc semble intéressante (je n'ai toujours pas eu le temps de me plonger dedans), alors autant s'investir dedans! 
Par contre je ne te cacherai pas que pour l'instant ça n'est pas notre priorité... Loin de là.

Par contre je ne te cacherai pas que pour l'instant ça n'est pas notre priorité... Loin de là.

Absolument, là Janot tu as raison. La rentrée est à nos portes (le jeux de mots ici...


AshLeDombos Membre non connecté
-
- Voir le profil du membre AshLeDombos
- Inscrit le : 11/05/2008
- Site internet

<a href="http://hodo.free.fr">
</a>


camille Membre non connecté
-
- Voir le profil du membre camille
- Inscrit le : 29/09/2008
- Site internet
je suis le responsable du projet documentation pour Mandriva, chez NeoDoc (http://www.neodoc.fr) et c'est nous qui nous occupons notamment du système de gestion de la doc, et de sa production.
Comme vous le savez la doc est écrite en XML DocBook à l'heure actuelle et si ça a plein d'avantages, ça comporte des inconvénients pour les débutants:
1) pour écrire de doc en docbook il faut connaitre XML et DocBook
2) pour traduire nous n'avons pas encore mis en place de système d'aide à la traduction (type PO).
Donc nos projets sont:
1) proposer un éditeur en ligne minimaliste (càd supportant un nombre minimal de tags DocBook) type AJAX.
2) proposer une version facilement traduisible des modules de doc anglais, soit sous forme de PO soit autre chose, soit carrément une interface en ligne...
Donc s'il y a des gens intéressés pour participer...
à bientôt sur irc.freenode.com #cooker-doc
Camille

Janot Membre non connecté
-
- Voir le profil du membre Janot
- Inscrit le : 18/02/2007
- Site internet
- Groupes :
-
Fondateur MLO

Merci de faire un tout ici.

Si je comprends bien vous recherchez des personnes ayant des compétences en XML / DockBook ainsi qu'en Ajax?
Répondre
Vous n'êtes pas autorisé à écrire dans cette catégorie