Zend FR

Consultez la FAQ sur le ZF avant de poster une question

Vous n'êtes pas identifié.

#51 08-01-2009 14:42:31

Delprog
Administrateur
Date d'inscription: 29-09-2008
Messages: 670

Re: Projet de documentation alternative pour le Zend Framework

Salut,

Arrête, s'il en trouve que 1000 il va penser que quelque chose ne vas pas smile

Pour le reste, c'est pas trop la bonne période pour que je me penche sur ce que tu as fais, mais je pense que je vais pouvoir me rendre plus dispo vers la fin du mois.

Dès que j'aurai regardé tu auras mon retour biensûr.


A+ benjamin.


http://www.anonymation.com/ - anonymation - Studio de création.
http://code.anonymation.com/ - anonymation - blog - développement et architecture web

Hors ligne

 

#52 08-01-2009 15:02:33

Vincent
Administrateur
Date d'inscription: 19-09-2008
Messages: 510

Re: Projet de documentation alternative pour le Zend Framework

Delprog a écrit:

Salut,

Arrête, s'il en trouve que 1000 il va penser que quelque chose ne vas pas smile

Pour le reste, c'est pas trop la bonne période pour que je me penche sur ce que tu as fais, mais je pense que je vais pouvoir me rendre plus dispo vers la fin du mois.

Dès que j'aurai regardé tu auras mon retour biensûr.


A+ benjamin.

Idem, je prends un peu de retard sur mon projet. D'ici un mois ça devrait aller mieux (enfin j'espère) smile


aka miboo

Hors ligne

 

#53 08-01-2009 15:12:18

gauthier
Membre
Date d'inscription: 30-09-2008
Messages: 116
Site web

Re: Projet de documentation alternative pour le Zend Framework

no problema les gars, à mon tour de vous dire "take your time" wink

il ne me reste (hélas) déjà plus que quelques jours de vacances, et je n'ai pas consacré le temps que j'aurais souhaité à mon appli... mais je reste très positif - on y arrivera quoi qu'il arrive smile


Consultant Zend Technologies // Blog perso : Logiciel libre et développement web -- http://freeblogware.org

Hors ligne

 

#54 31-01-2009 19:21:55

gauthier
Membre
Date d'inscription: 30-09-2008
Messages: 116
Site web

Re: Projet de documentation alternative pour le Zend Framework

Bonsoir à tous

un petit update pour vous dire, si jamais ça en intéresse encore d'autres que moi-même smile, que j'ai pu avancé aujourd'hui sur CDM (outil support du projet de doc alternative).

J'ai fait un peu de nettoyage, et j'ai surtout ajouté le niveau de navigation qui manquait, à savoir la méthode.

Malheureusement, en arriver là mène également à un triste constat... le blocs PHPDoc ne sont que trop rarement renseignés correctement dans les sources !

Mais bon, ce n'est pas un drame, on fera sans smile

Prochaines étapes (majeures) : supporter plusieurs versions (ZF 1.0, 1.5, 1.6...) afin que l'on puisse accéder directement à la doc de la version que l'on utilise, et enfin, bien sûr, ajouter la possibilité de compléter le "squelette" que propose actuellement la base, reposant uniquement sur les sources...

J'aimerais vous solliciter sur ces points... je ne sais pas encore trop comment implémenter la possibilité d'intéragir pour ajouter des commentaires, exemples, mini-tutos ?, etc.

Pour le moment, j'imagine une sorte de wiki modéré (a posteriori sans doute), multi-lingue et multi-version. Ex: j'ajoute la description d'une méthode, je précise si ma description s'applique à telle ou telle, ou encore telles versions.

J'attends vos commentaires !

PS : pour mémoire, la version courante est visible sur http://cdm.gauthier.homelinux.net et le svn sur http://gauthier.homelinux.net/svn/cdm/


Consultant Zend Technologies // Blog perso : Logiciel libre et développement web -- http://freeblogware.org

Hors ligne

 

#55 31-01-2009 19:32:50

mikaelkael
Administrateur
Lieu: Donges
Date d'inscription: 18-06-2007
Messages: 1176
Site web

Re: Projet de documentation alternative pour le Zend Framework

Hello,

Tu as le principe Django (http://www.djangobook.com/en/2.0/) par exemple.

A+


Less code = less bugs
Contributeur ZF - ZCE - ZFCE - Doc ZF (CHM & PDF) - Vice-trésorier AFUP 2011
Ubuntu 11.04 - ZendServer

Hors ligne

 

#56 05-02-2009 11:20:48

Vincent
Administrateur
Date d'inscription: 19-09-2008
Messages: 510

Re: Projet de documentation alternative pour le Zend Framework

gauthier a écrit:

Bonsoir à tous

un petit update pour vous dire, si jamais ça en intéresse encore d'autres que moi-même smile, que j'ai pu avancé aujourd'hui sur CDM (outil support du projet de doc alternative).

J'ai fait un peu de nettoyage, et j'ai surtout ajouté le niveau de navigation qui manquait, à savoir la méthode.

Malheureusement, en arriver là mène également à un triste constat... le blocs PHPDoc ne sont que trop rarement renseignés correctement dans les sources !

Mais bon, ce n'est pas un drame, on fera sans smile

Prochaines étapes (majeures) : supporter plusieurs versions (ZF 1.0, 1.5, 1.6...) afin que l'on puisse accéder directement à la doc de la version que l'on utilise, et enfin, bien sûr, ajouter la possibilité de compléter le "squelette" que propose actuellement la base, reposant uniquement sur les sources...

J'aimerais vous solliciter sur ces points... je ne sais pas encore trop comment implémenter la possibilité d'intéragir pour ajouter des commentaires, exemples, mini-tutos ?, etc.

Pour le moment, j'imagine une sorte de wiki modéré (a posteriori sans doute), multi-lingue et multi-version. Ex: j'ajoute la description d'une méthode, je précise si ma description s'applique à telle ou telle, ou encore telles versions.

J'attends vos commentaires !

PS : pour mémoire, la version courante est visible sur http://cdm.gauthier.homelinux.net et le svn sur http://gauthier.homelinux.net/svn/cdm/

Ça avance smile

Pourquoi pas un wiki modéré, cela me semble intéressant, mais est-ce que ce type de solution permet également l'interaction via l'ajout de commentaires !?

As-tu besoin d'aide ?


aka miboo

Hors ligne

 

#57 05-02-2009 13:44:52

gauthier
Membre
Date d'inscription: 30-09-2008
Messages: 116
Site web

Re: Projet de documentation alternative pour le Zend Framework

j'aime assez l'idée d'un wiki - seulement je ne connais pas suffisamment les moteurs disponibles pour savoir s'il en serait au moins un adapté aux contraintes du projet, notamment 1) la gestion des versions 2) le support multi-lingue

Cela dit, un wiki, ce n'est pas franchement compliqué à coder wink

Mais cela n'empêche pas que j'aurai besoin d'aide, c'est certain !!!


Consultant Zend Technologies // Blog perso : Logiciel libre et développement web -- http://freeblogware.org

Hors ligne

 

#58 10-03-2009 12:02:10

Jean-Marc Rigade
Membre
Lieu: Rennes
Date d'inscription: 25-09-2007
Messages: 314

Re: Projet de documentation alternative pour le Zend Framework

Bonjour à tous,

je réactualise cette discussion, car je me demande si il y a du neuf ou pas.
Je ne veux surtout pas mettre la pression, je sais que nous avons tous notre lot de code à produire.

Ce qui existe pour le moment est sympa, mais pas tellement éloigné de ce que l'on peut obtenir avec un phpdoc.
(Pardon si je n'ai pas compris l'utilisation de ce qui a été mis en ligne)

J'espérais plutôt rassembler des questions concrètes et fréquentes pour lesquelles des réponse concrètes et complètes (c'est à dire prêtes à tourner) sont fournies.
Tant pis si dans les réponses il y a du code standard, il faut que l'on puisse récupérer une archive, on la décompresse dans le répertoire de son serveur de test, et mis à part un ou deux réglages pour les chemins, l'exemple tourne tout de suite et peut être étudié.

Avec comme règle absolue, l'exemple répond à la question et rien de plus. ça peut être tentant pour quelqu'un qui maitrise bien le sujet d'en faire un peu plus, en ce disant comme ça ils voient cette technique aussi et c'est cadeau.
En fait c'est le contraire, ce n'est pas un cadeau. Pour que ce soit facilement réutilisable il ne faut pas de "hors sujet".

Personnellement je m'étais proposé pour rassembler les demandes les plus fréquentes et pour tester les exemples, car rien n'est plus frustrant que de récupérer le code qui doit répondre à votre problème, et en fait nada, rien, ça ne tourne pas et on perd encore une ou deux journées pour faire tourner le code qui devait vous sortir la tête hors de l'eau...

Encore une chose, si par exemple on a des exemple type ajax, il faudrait une réponse avec les bibliothèques prises en compte par le ZF (Jquery et Dojo)...

Dernière modification par Jean-Marc Rigade (10-03-2009 12:04:11)

Hors ligne

 

#59 10-03-2009 17:29:28

gauthier
Membre
Date d'inscription: 30-09-2008
Messages: 116
Site web

Re: Projet de documentation alternative pour le Zend Framework

Bonjour Jean-Marc,

tout d'abord merci à toi de redonner un peu de vie à ce thread wink

Il est vrai que je ne dispose que de très peu de temps en ce moment à consacrer à ce projet. Il n'est toutefois absolument pas question pour moi de l'abandonner ! Et à ce propos, des contributions comme celle que tu viens de faire sont vraiment très positives (voir commentaires ci-dessous).

Ce qui existe pour le moment est sympa, mais pas tellement éloigné de ce que l'on peut obtenir avec un phpdoc.

Tu as raison - je m'en suis rapidement aperçu, et à dire vrai ça ne me déplait pas wink Je me dis que le projet une fois étoffé pourra être packagé pour être réutilisé sans pour d'autres frameworks/librairies. En réalité, tout démarre par un parser PHPDoc - mais il y a beaucoup plus de fonctionnalités prévues dans mon projet (à commencer par la gestion de version, la recherche, et surtout la gestion des contributions - commentaires, exemples...)

il faut que l'on puisse récupérer une archive, on la décompresse dans le répertoire de son serveur de test, et mis à part un ou deux réglages pour les chemins, l'exemple tourne tout de suite

100% d'accord - cela fait partie des pistes envisagées (mais peut-être pas explicitées dans le forum)

Enfin, je ne suis pas contre tâcher de répondre aux FAQ que tu pourrais rassembler, mais j'imagine ça comme une "méta" rubrique du site, qui serait constituée automatiquement par les exemples les plus consultés et/ou téléchargés. Mais ces exemples, je préférerais les rattacher à l'arborescence package/subpackage/class/method. Qu'en penses-tu ?

Promis, je vais essayer de m'y remettre au plus tôt !

Gauthier


Consultant Zend Technologies // Blog perso : Logiciel libre et développement web -- http://freeblogware.org

Hors ligne

 

#60 11-03-2009 09:26:15

Jean-Marc Rigade
Membre
Lieu: Rennes
Date d'inscription: 25-09-2007
Messages: 314

Re: Projet de documentation alternative pour le Zend Framework

Bonjour,

je pense aussi que le point d'entrée pour la réponse à une question peut être une méthode ou une classe.
Avec malgré tout d'autres possibilités d'accès, car il peut arriver que le problème soit là mais que l'on soit tellement peu familier du domaine que l'on ne puisse pas aller directement sur la bonne classe.

Comment chercher la définition d'un mot dont on ne connait pas l'existence ?

Ceci dit, l'idée de pouvoir "raccrocher" des commentaires et des exemples à l'arborescence que tu as généré me plait bien.

En tout cas tu peux compter sur moi pour apporter ma pierre à l'édifice, dans la mesure de mes compétences. Et je suis conscient que toi aussi, le vrai luxe, c'est du temps libre...

Hors ligne

 

#61 11-03-2009 09:53:41

Vincent
Administrateur
Date d'inscription: 19-09-2008
Messages: 510

Re: Projet de documentation alternative pour le Zend Framework

Cela me semble plus cohérent de mettre en relation directement les exemples avec l'arborescence. Après, il est toujours possible de mettre en place un système de tags ou de remontés des sujets les plus populaires, non?

Dernière modification par miboo (11-03-2009 10:44:35)


aka miboo

Hors ligne

 

#62 11-03-2009 22:42:17

gauthier
Membre
Date d'inscription: 30-09-2008
Messages: 116
Site web

Re: Projet de documentation alternative pour le Zend Framework

c'est en effet comme ça que je le vois : rattacher les exemples directement aux composants qui les concernent mais permettre de les retrouver selon différents modes (arborescence, catégories, top consultations, tags, recherche...)


Consultant Zend Technologies // Blog perso : Logiciel libre et développement web -- http://freeblogware.org

Hors ligne

 

#63 12-03-2009 14:56:39

Vincent
Administrateur
Date d'inscription: 19-09-2008
Messages: 510

Re: Projet de documentation alternative pour le Zend Framework

En ce qui concerne la FAQ suggérée, faites vous une grande différence entre une FAQ standard (qui existe déjà à l'adresse suivante http://www.itanea.com/blog/faq/index.ph … &cat=1 ) et une FAQ intégrée à ce projet de documentation alternative?


aka miboo

Hors ligne

 

#64 14-03-2009 11:55:27

Jean-Marc Rigade
Membre
Lieu: Rennes
Date d'inscription: 25-09-2007
Messages: 314

Re: Projet de documentation alternative pour le Zend Framework

La FAQ d'Itanea est très bien.
Il suffirait de rattacher les élément à l'arborescence de la documentation alternative, et aussi de fournir un exemple complet et directement utilisable pour chaque élément de la faq.
Ce dernier point est fastidieux mais me semble important pour quelqu'un qui découvre le domaine.

Dernière modification par Jean-Marc Rigade (14-03-2009 11:55:46)

Hors ligne

 

#65 15-03-2009 11:07:33

gauthier
Membre
Date d'inscription: 30-09-2008
Messages: 116
Site web

Re: Projet de documentation alternative pour le Zend Framework

Ce dernier point est fastidieux mais me semble important pour quelqu'un qui découvre le domaine.

100% d'accord Jean-Marc - je dirai même que cela résume assez bien l'ambition du projet. Ainsi que je l'avais dit lors de son annonce, je souhaite coller au plus près à l'esprit de la doc PHP, qui précisément offre pour chaque fonction ou presque un exemple complet et fonctionnel d'utilisation.

Pour ZF, c'est évidemment un peu plus complexe... je suggère de créer un modèle de module, incluant une base de données SQLite, qui servirait de base à tous les exemples. A ce modèle en serait adjoint un autre pour un déploiement complet.

Ainsi, chaque exemple pourrait être téléchargé soit sous forme d'un module à insérer dans un projet existant, soit sous forme d'un projet complet prêt-à-l'emploi.

Bien sûr, ces modules d'exemple pourrait servir à illustrer plusieurs composants à la fois. Par exemple, pour la traduction... on créé un module complet, et on y fait référence dans toutes les pages de la doc en rapport.

Ca vous irait comme ça ?? smile


Consultant Zend Technologies // Blog perso : Logiciel libre et développement web -- http://freeblogware.org

Hors ligne

 

#66 16-03-2009 13:50:16

gchau
Membre
Date d'inscription: 15-05-2008
Messages: 17

Re: Projet de documentation alternative pour le Zend Framework

Cette discussion extrêmement longue et peut-être interminable qu’il est impossible de résumer d’une phrase mais qui tourne autour du fossé qui sépare la documentation ZF de sa mise en œuvre m’a amené à quelques réflexions que je vais me permettre (après hésitations) de vous soumettre.

Je crois que la documentation officielle est irremplaçable en tant que description extrêmement rigoureuse des
composants élémentaires de ZF, par contre elle s’avère assez limitée quand il s’agit de décrire finement comment utiliser au mieux certains  mécanismes fournis par ZF faisant intervenir plusieurs composants élémentaires et plus encore lorsqu’il s’agit d’indiquer comment réaliser simplement (minimum de code mais clair et évolutif) nos propres mécanismes avec en plus la contrainte de la performance.
Je pense que le projet de Gauthier bien qu’il soit certainement très intéressant  pour faire ressortir les liens
profonds  et pas toujours évidents entre les composants ZF n’épuise pas la question du gap  entre doc et dev.


Les forums, tutoriaux , blogs, livres et faq comblent en partie ce manque de dimension pratique de la doc qui n’est pas spécifique à ZF mais inhérent à toute doc technique :

    -Les forums du fait de leur caractère d’entraide sont des lieux ou l’interactivité est reine mais ou la moisson très riches des problèmes/solutions n’est pas capitalisée d’une manière organisée simplifiant la recherche . En particulier les questions de bonnes ou meilleures pratiques sont souvent présentes et donnent parfois lieu à des débats intéressants mais il n’en ressort pas ou rarement de mise en forme du type design pattern ou use case générique.

    -Les tutoriaux blogs, livres ainsi que morceaux de codes sur internet sont également très précieux mais malheureusement  comme pour les forums les problèmes/solutions on souffre en tant que lecteurs d’un certain éparpillement et  de l’absence de mise à jour.       

    -Les faqs sont rares,  un peu isolés et limités dans leur contenu .Je ne critique pas pour critiquer je suis conscient du gros travail effectué mais je note simplement la difficulté de ce genre de projet très voisin de celui qu’il faudrait entreprendre pour combler le gap doc dev  car son succès s’il est souhaité n’est pas pour autant garanti.

En gros ce que je verrai c’est un outil comportant un aspect orienté débats autour des meilleures pratiques (avec variantes et affinements possibles)  et un aspect  capitalisations sous forme condensé de ce qui en ressort .

Le contenu pourrait bien sur dépasser largement le périmètre ZF qui est centré sur un MVC étendu mais il me semble que déjà rien que sur ce sujet on a de quoi faire pour fixer des principes visant à des applis évolutives
et performantes .
Sans rentrer dans le détail mais simplement pour être un peu concret je pense par exemple à la construction
par blocs de page basé sur zend_layout avec utilisation préférentielle de helpers standards, partagés ou persos   ;ceci avec le souci de performance mais sans à priori exclure l’actionstack voire le helper action.
(cf [ur] http://www.rmauger.co.uk/2009/03/why-th … k-is-evil/[/url])


Il y a aussi (entre autres) mvc vu de zend_form ou l’utilisations des plugins et les action helpers pour remplir des fonctionnalités transversales ou génériques.

La structuration des sujets pourrait se traduire par un menu  probablement arborescent et éventuellement évolutif conduisant soit à un discussion soit à la consultation de ou des couples problème/solution retenus.

Réaliser un tel outil pose bcp de questions dont je n’ai que des bribes de solutions et comme il n’y a pas de faq sur la question il faudra bien que ceux qui veulent participer en discutent...

De plus à mon avis  un tel outil étant nécessairement collaboratif n'est envisageable que comme un prolongement de zf.fr.

Pardon d’être un peu long et sans doute péremptoire dans mes idées mais tant mieux si j’ai pu intéresser,  voire faire réagir, voire plus encore : donner envie de participer un jour à un projet de pont entre doc et dev tel que vaguement esquissé ici ou tout à fait différent; peu importe.

Hors ligne

 

#67 16-03-2009 14:01:05

gauthier
Membre
Date d'inscription: 30-09-2008
Messages: 116
Site web

Re: Projet de documentation alternative pour le Zend Framework

Salut gchau,

et tout d'abord merci d'avoir pris le temps de contribuer au débat !

Je vais tâcher de te répondre assez brièvement pour ne pas rendre la discussion trop rébarbative au nouveaux arrivants wink

Je suis assez d'accord avec tes constats, notamment la description que tu fais des différentes sources/modes d'entre-aide (forums, faq, tuto, doc officielle, etc...). En revanche, je n'en tire pas la même conclusion : l'ambition du projet que j'ai exposé ici est justement de proposer une structure de documentation permettant de garder le meilleur de ces différents canaux tout en essayant d'en limiter les écueils.

Ce ne sera pas simple, mais je suis persuadé que c'est parfaitement faisable. Et des contributions comme la tienne vont nous y aider à n'en pas douter wink

Enfin, pour ce qui est de considérer cet outil comme prolongement de z-f.fr, je ne suis pas d'accord, et ce pour plusieurs raisons : le projet que j'ai baptisé CDM est un moteur de doc alternative. Il se trouve que Zend Framework est le projet m'ayant amené à créer le projet, mais il ne sera pas le seul à en profiter à terme. Deuxièmement, le projet se veut multi-lingue, et je ne souhaite donc pas l'identifier comme projet francophone. Enfin, z-f.fr a ses propres objectifs, et je ne souhaite en détourner ses auteurs wink


Consultant Zend Technologies // Blog perso : Logiciel libre et développement web -- http://freeblogware.org

Hors ligne

 

#68 27-03-2009 15:07:03

Nikko
Membre
Lieu: Rueil (Haut-de-Seine)
Date d'inscription: 19-12-2008
Messages: 95

Re: Projet de documentation alternative pour le Zend Framework

Bonjour à tous,

Je voulais vous féliciter de votre courage et de vos intentions envers ce projet. Je trouve cette idée fabuleuse. Je suis jeune débutant sur PHP / Zend / Framework (je suis en stage et j'ai appris PHP et Zend sur le tas.. Et je n'avais jamais utilisé de framework auparavant), et je vous avoue que sans ce forum, je m'y perds un peu (pour ne pas dire beaucoup).

Je ne peux que vous encourager (étant donné que j'ai des compétences limités pour le moment) et vous féliciter encore une fois !

Courage !

Cordialement,
Nikko


Nikko

Etudiant en école d'ingénieur à l'INSIA

Hors ligne

 

#69 27-03-2009 16:42:34

gauthier
Membre
Date d'inscription: 30-09-2008
Messages: 116
Site web

Re: Projet de documentation alternative pour le Zend Framework

Merci à toi Nikko pour ce message, qui s'adresse plus à l'ensemble des contributeurs du forum z-f.fr qu'au projet dont il est question dans ce post wink


Consultant Zend Technologies // Blog perso : Logiciel libre et développement web -- http://freeblogware.org

Hors ligne

 

Pied de page des forums

Propulsé par PunBB
© Copyright 2002–2005 Rickard Andersson
Traduction par punbb.fr

Graphisme réalisé par l'agence Rodolphe Eveilleau
Développement par Kitpages