[spip-dev] Référentiel des plugins

Hello,

Sur la route de la Refonte de Contrib, le moment est venu de s’attaquer aux pages elles-mêmes et d’intégrer Plugins SPIP.
Je rappelle que ceux qui souhaitent y participer peuvent s’inscrire sur le Framablog et fournir leur idée, maquette et plus si affinité.
Maintenant, comme disait un certain « bip » : shit in shit out !

J’ai fait un rapide tour d’horizon des plugins / paquets inclus dans le référentiel et il y a encore beaucoup de plugins sans slogan, sans description et sans documentation.
Et franchement c’est chiant et très démotivant pour ceux qui s’échinent à améliorer tous les jours l’écosystème SPIP. Il y a 120 plugins sans slogan et au moins autant de paquets sans descriptions.

Quelques règles que l’on pourrait tous adopter :

  • si un plugin a un nom composé d’un acronyme ou d’un terme générique ou obscur, il est essentiel de l’affubler d’un slogan. Cela permet de rapidement capter de quoi on parle. Personnellement j’en met toujours et c’est ce que je conseille.
  • dans tous les cas, qu’il existe un slogan ou pas, il faut écrire une petite description du plugin qui a l’avantage de pouvoir être traduite.
  • enfin, slogan et description ne remplacerons jamais une documentation : un article sur Contrib est le bienvenu voire un readme dans le plugin avec le lien de doc dans le paquet.xml.

Je ne sais pas si c’est possible mais un plugin qui n’a ni slogan, ni description et ni documentation ne devrait pas être référencé dans l’annuaire des plugins de SPIP.

Donc si vous pouvez y faire attention à l’avenir voire corriger l’existant, ce serait vraiment cool.

Merci d’avance.

Hop,

Une réponse pas super constructive, mais ça en fera au mois une :stuck_out_tongue:

Maintenant, comme disait un certain « bip » : shit in shit out !

Je ne vois pas de qui tu parles :stuck_out_tongue:

J’ai fait un rapide tour d’horizon des plugins / paquets inclus dans le référentiel et il y a encore beaucoup de plugins sans slogan, sans description et sans documentation.

Amha, un plugin dans cet état n'a rien à faire sur plugins.spip, si je me souviens bien de la dernière fois que j'ai publié un module firefox, il est impossible de le rendre public sans description. Donc, je pense que si un plugin ne contient aucun des ces trois éléments, il faut le masquer sur le site, ça peut être fait de manière crade et brutal avec un test depuis la page du plugin qui ferait un |sinon_interdire_acces en mode 302 vers la home et zou (j'avais prévenu, c'est crado).

Il y a 120 plugins sans slogan et au moins autant de paquets sans descriptions.

<troll>120 plugins qui ne servent à personne sauf à leur auteur donc</troll> ou sans troller 120 plugins dont l'auteur ne souhaite pas la diffusion parce que (cochez les bonnes cases) : c'est pas fini, c'est une expérimentation, etc.

Quelques règles que l’on pourrait tous adopter :
- si un plugin a un nom composé d'un acronyme ou d’un terme générique ou obscur, il est essentiel de l’affubler d’un slogan. Cela permet de rapidement capter de quoi on parle. Personnellement j’en met toujours et c’est ce que je conseille.

Claro, j'ai toujours eu du mal à comprendre l'utilité du slogan dans SPIP ou pour les plugins, sauf pour le plugin GIS dont le slogan permet d'expliquer que ça à rapport avec le "système d’information géographique".

- dans tous les cas, qu’il existe un slogan ou pas, il faut écrire une petite description du plugin qui a l’avantage de pouvoir être traduite.

Amha c'est ce champ qui devrait permettre d'exclure les plugins du site, si ça n'est pas présent on masque le plugin, et s'il y a une doc et pas de descriptif, c'est pas compliqué d'en ajouter un, le chapo de la doc peut faire l'affaire par exemple.

- enfin, slogan et description ne remplacerons jamais une documentation : un article sur Contrib est le bienvenu voire un readme dans le plugin avec le lien de doc dans le paquet.xml.

+1, comme on le dit souvent, ce qui n'est pas documenté ne sert qu'à l'auteur ou à un cercle restreint qui peut communiquer avec l'auteur. Ça pourrait même poser la question de la légitimité de la présence du plugin sur la zone...

Donc si vous pouvez y faire attention à l’avenir voire corriger l’existant, ce serait vraiment cool.

Partage la liste des 120 plugins ici ou dans un pad histoire d’interpeller leurs auteurs pour qu'ils/elles corrigent ça :slight_smile:

Hop,

Une réponse pas super constructive, mais ça en fera au mois une :stuck_out_tongue:

Maintenant, comme disait un certain « bip » : shit in shit out !

Je ne vois pas de qui tu parles :stuck_out_tongue:

J’ai fait un rapide tour d’horizon des plugins / paquets inclus dans le référentiel et il y a encore beaucoup de plugins sans slogan, sans description et sans documentation.

Amha, un plugin dans cet état n'a rien à faire sur plugins.spip, si je me souviens bien de la dernière fois que j'ai publié un module firefox, il est impossible de le rendre public sans description. Donc, je pense que si un plugin ne contient aucun des ces trois éléments, il faut le masquer sur le site, ça peut être fait de manière crade et brutal avec un test depuis la page du plugin qui ferait un |sinon_interdire_acces en mode 302 vers la home et zou (j'avais prévenu, c'est crado).

Il y a 120 plugins sans slogan et au moins autant de paquets sans descriptions.

<troll>120 plugins qui ne servent à personne sauf à leur auteur donc</troll> ou sans troller 120 plugins dont l'auteur ne souhaite pas la diffusion parce que (cochez les bonnes cases) : c'est pas fini, c'est une expérimentation, etc.

je pense aussi que sans lien de doc ou description, inutile de publier.

Le slogan perso j'en comprend pas le but dans 90 % des cas (cf remarques de b_b et Eric plus bas)

Quelques règles que l’on pourrait tous adopter :
- si un plugin a un nom composé d'un acronyme ou d’un terme générique ou obscur, il est essentiel de l’affubler d’un slogan. Cela permet de rapidement capter de quoi on parle. Personnellement j’en met toujours et c’est ce que je conseille.

Claro, j'ai toujours eu du mal à comprendre l'utilité du slogan dans SPIP ou pour les plugins, sauf pour le plugin GIS dont le slogan permet d'expliquer que ça à rapport avec le "système d’information géographique".

- dans tous les cas, qu’il existe un slogan ou pas, il faut écrire une petite description du plugin qui a l’avantage de pouvoir être traduite.

Amha c'est ce champ qui devrait permettre d'exclure les plugins du site, si ça n'est pas présent on masque le plugin, et s'il y a une doc et pas de descriptif, c'est pas compliqué d'en ajouter un, le chapo de la doc peut faire l'affaire par exemple.

oui

- enfin, slogan et description ne remplacerons jamais une documentation : un article sur Contrib est le bienvenu voire un readme dans le plugin avec le lien de doc dans le paquet.xml.

+1, comme on le dit souvent, ce qui n'est pas documenté ne sert qu'à l'auteur ou à un cercle restreint qui peut communiquer avec l'auteur. Ça pourrait même poser la question de la légitimité de la présence du plugin sur la zone...

oui

En parlant de liens de docs, justement, tu ne donnes pas le lien du framamachin...

https://framavox.org/g/HWIQ0bwl/spip-ga-refonte-de-contrib-spip-net

tu verra il y a plein de questions encore ouvertes :slight_smile: