Annexer les ZEP à la documentation

Hello,

Ne serait-il pas judicieux de joindre à la documentation existante les ZEP.

Si oui, il faudrait déterminer lesquelles. Les terminés et développés ? Toutes.

Je pense qu'il serait intéressant de les joindre car elles contiennent souvent des informations précieuses. Aussi quelqu'un qui ne connaît pas ce forum ne sera probablement pas à quoi correspond ZEP lorsqu'il regarde le dépôt et le nom des branches (par exemple).

Sur le forum elle ne sont pas triés et contextualisés. Une introduction au ZEP, à leurs fonctionnements, buts, etc. serait pas de trop pour compléter cette doc qui a déjà belle allure.

Sur le forum elle ne sont pas triés et contextualisés.

Si, il y a les tags.

Une introduction au ZEP, à leurs fonctionnements, buts, etc. serait pas de trop pour compléter cette doc qui a déjà belle allure.

C'est la ZEP-01 postitée en tête de forum.

Et dans la doc les ZEP sont en généralement bien intégrées aussi, seulement elles perdent le nom de ZEP car elles deviennent alors un morceau de l'ensemble. (par exemple la ZEP-3 ou la ZEP-API)

Dans tous les cas les ZEP ne sont tous que des projets. Elles ne peuvent intégrer la doc que si elles sont accepté, validés et développé. On ne va pas mettre dans la doc des trucs non implémenté. Comme le dit Eskimon, avec un dev de l'importance d'une ZEP, une mise a jour de la doc est indispensable. C'est là que le processus de transfert vers la doc va avoir lieu. Dans la doc, aucun besoin de conserver tout l'historique de conversation.

Ce qui pourrait être réfléchit, par contre, c'est créer un module dédié aux zep. Pour autant, pour le moment, le forum se debrouille plutôt bien pour gérer ça.

Je ne suis pas pour. Si je prends comme exemple les ZEP API auxquels je contribue le plus, elles deviennent très rapidement obsolète. Il y a eu la première ZEP(-17) sur l'API des membres qui est très basique et une nouvelle ZEP(-23) a été développée sur l'API des MPs qui a apporté son lot de nouveau. e.g., la possibilité d'étendre le résultat d'un identifiant pour en voir le contenu. Quant à la dernière ZEP(-30) en date, elle prend un tournant qui pourrait encore apporter une grosse nouveauté. Tout ça pour dire que la première ZEP(-17) sera un jour mise à jour, la ZEP-23 aussi et sans doute la ZEP-30 sauf que ça ne sera plus dans le cadre des ZEP mais dans le cadre d'une contribution à du code existant dans le projet. Il va donc y avoir un décalage entre la spécification de la ZEP et sa mise en oeuvre.

Je rajouterais aussi que le développement d'une ZEP inclue aussi sa documentation. Aujourd'hui, la documentation officielle de Zeste de Savoir couplée avec la documentation Swagger de l'API couvre beaucoup plus de choses que la spec de la ZEP.