Framavox

Action 0 - Structuration de la documentation des plugins

M Maïeul Public Seen by 25

La décision est de laisser les articles de plugins sur Contrib en réorganisant les rubriques (voir les actions suivantes). La possibilité d'intégrer la page plugin de Plugins SPIP à Contrib sera discutée plus tard.

Les plugins sont documentés de plusieurs manières:
- documentation techniques automatique pour certaines
- documentation utilisateur·trice·s qui peuvent être de différent profil:
- rédacteur
- webmestre
- intégrateur
- documentation factuelle : info sur l'état du plugin, la version, la compat

La question se pose de savoir
a) si toutes ces infos doivent être sur le même site, et si oui, est-ce Contrib ou Plugins SPIP
b) si il faut un site à part pour les elements factuels
c) comment gère-t-on les gens qui préfère documenter le plugin dans le depot svn/git lui-même

A ceci s'ajoute des metas documentations qui permettent d'expliquer comment arriver à un besoin en regroupant plusieurs plugins (ex pour les newsletters)

M

Maïeul Fri 29 Mar 2019 4:22PM

je me rend compte que ma phrase est ambigu. Nous sommes d'accord, en tout cas toi et moi, sur ce qu'on doit fournir en terme de contenu sur l'un et l'autre site. Encore qu'il y a la question du filtrage aussi sur rcontrib. Sur comment on fait techniquement entre les deux sites, j'aurai des remarques, mais accordons d'abord sur ce qu'on fait sur chaque site.

LE

Lupinacci Eric Fri 29 Mar 2019 4:42PM

Plugins SPIP fournit déjà une API REST. C'est le plugin SVP API HTTP qui est installé depuis des lustres sur le site. Suite à une demande de Teddy j'avais créé ce plugin basé sur Serveur HTTP abstrait et qui fournit une API sur les collections plugin et paquet. Il faudrait que je revois le truc pour voir si il conviendrait votre utilisation mais si c'est pas le cas ça doit être sorcier de le faire évoluer.

Après j'attire votre attention sur le fait que le préfixe renvoie à un plugin alors que parfois les docs ne concernent qu'un paquet du plugin. Je reste convaincu aujourd'hui que laisser la documentation sur Contrib va nous demander des contorsions et des synchronisations compliquées voire non déterministe car il y aura toujours des cas non renseignés ou tordus alors qu'avec la bonne organisation sur Plugins en lien avec les catégories, les préfixes voire les paquets cette complexité serait atténuée (pas éliminée je pense).

Pour compléter on peut activer l'API ainsi:
https://plugins.spip.net/http.api/svp/plugins/boussole

LE

Lupinacci Eric Fri 29 Mar 2019 5:17PM

Soit mais moi je ne suis pas d'accord. Ca serait bien qu'on ne soit pas les seuls à se prononcer d'ailleurs. Faudrait aussi intégrer ma proposition d'hier sur laquelle certains ont répondu dans le débat ici non?
On devrait peut-être inviter les gens à venir en parler ici, je ne suis pas sur que tous soient au courant.

R

RastaPopoulos Fri 29 Mar 2019 5:28PM

Pour la manière de travail, je ne crois pas ce que soit bien de faire une consultation générale en faisant venir 12000 personnes ici. Le but d'un sous-groupe dans Loomio c'est d'avoir un groupe de travail, pas 50 personnes dans le même groupe, seulement celles qui vont travailler sur le long terme sur un sujet précis (et qui donc s'engagent à être dispo, à réunioner, répondre, etc).

LE

Lupinacci Eric Fri 29 Mar 2019 5:31PM

Oui je suis d'accord mais là c'est un peu restreint comme cercle, nos avis divergent et d'autres ont émis des avis différents par mail qui ne sont pas retranscrits ici.

M

Maïeul Fri 29 Mar 2019 6:00PM

oui, il faut inviter, mais en expliquant explicitement ce que cela
implique en terme de charge de travail

Et du coup ... peut être se définir une méthode de travail (mais dans un
flux à part)

LE

Lupinacci Eric Fri 29 Mar 2019 7:23PM

Je remets ici mon mail sur la réorganisation possible de Plugins SPIP comme annuaire étendu des plugins (incluant les documentations).

La première vue représente la page sommaire.
On retrouve presque tous les éléments actuels de la page sommaire du Plugins SPIP.
La liste des catégories est en navigation droite et on s'autorise deux niveaux (à confirmer plus tard).
https://pic.infini.fr/jWMEdEeD/vUUQhhUn.png

La deuxième vue représente la page d'un plugin au sens de Plugins SPIP actuel.
On voit par contre à droite les articles de doc qui sont regroupés dans un bloc de navigation.
Le bloc d'information d'un plugin est en partie droite et porte les informations qu'on retrouve aujourd'hui sur Contrib.
Un peu de couleur sur les versions SPIP en lien avec l'article des versions maintenues sur SPIP.net. Ca permet d'avertir sur l'intérêt aussi d'un plugin si celui-ci n'a que des versions "rouges". On pourrait aussi dans ce cas ajouter un bloc d'avertissement en bloc central.
Le contenu central est très similaire à celui de Plugins SPIP actuel.
https://pic.infini.fr/7fetLWjh/MGtOgy3X.png

La troisième vue représente celle d'un article de doc d'un plugin donné.
On retrouve en partie centrale le bloc du haut avec le nom et le slogan du plugin et dessous l'article et ses messages de forum.
A droite le bloc du plugin est toujours là et comporte aussi les zips et les liens vers l'autodoc, le source et la page de type annuaire (la précédente).

https://pic.infini.fr/5u5jPHJ5/0t2QSdZc.png

Les couleurs, le layout, le manque d'espace ne sont pas des features : c'est du manque de temps pour faire mieux, le but étant de montrer l'idée générale.
Il faut aussi imaginer les autres pages actuelles de Plugins SPIP (téléchargements, statistiques, valider paquet...) et de Contrib (contributeurs).

LE

Lupinacci Eric Fri 12 Apr 2019 12:34PM

Cette action préliminaire est considérée comme close. La décision est de laisser les articles de plugins sur Contrib en réorganisant les rubriques (voir les actions suivantes). La possibilité d'intégrer la page plugin de Plugins SPIP à Contrib sera discutée plus tard.