Pour developpeurs: Ou stocker la doc des plugins et moyen d'acces

Bonjour

Dans ce lien https://doc.jeedom.com/fr_FR/dev/plugin_template
il est mentionné de mettre la doc du plugin dans son repertoire « docs »

docs : doit contenir la doc du plugin au format markdown, la racine et le fichier index.md. Toutes les images sont dans docs/images. La doc elle-même est dans un dossier en fonction de la langue (ex en francais : docs/fr\_FR )

Comment un utilisateur y accede ? Par quelle URL ?
Si cette procedure est caduqe, quel est le moyen d’acceder à une doc qui serait dans le plugin lui meme ?
Merci

Salut @tcharp38,

Il faut activer les github pages.

Je t’invite à te référer à cette documentation spécifique à la mise en place d’une doc de plugin : https://doc.jeedom.com/fr_FR/dev/documentation_plugin

N’hésites pas également à regarder comment les docs sont gérées sur d’autres plugins.

1 « J'aime »

Bonjour,

Le lien qu’à donné @Salvialf suffit en soit mais je voulais juste préciser qu’en fait tu as le droit de mettre ta doc où tu veux (accessible en http qd même), tant que l’URL de la doc est bien définie dans le plug-in info.json.

Dans les faits, un github page reste effectivement la solution la plus simple à mon avis.

Aussi n’hésites pas à faire ton inscription dev si tu as un plug-in en cours, ça te permettra d’avoir accès à la section réservé à ce type de question sur communauté et donc d’avoir des réponses plus rapidement car la question sera plus visible.

1 « J'aime »

J’avais déja exploré cette solution mais elle ne permet de n’exporter qu’une « version », celle d’une branche particuliere (ex; branche gh-page).
Mais du coup quel interet qu’elle soit dans le plugin vu qu’elle n’est pas gérée par Jeedom ?
Il est dommage de ne pas pouvoir acceder directement à la doc qui serait dans le plugin.

Pour info je bosse sur le plugin Abeille donc pas un nouveau.

En creusant un peu j’ai pu acceder à un bout de doc directement sur host Jeedom
par ex
/index.php?v=d&&m=Abeille&p=docs
et dans le plugin j’ai
desktop/php/docs.php
qui me renvoi vers docs/fr_FR
Ca semble fonctionner comme ca.

L’avantage d’un acces sur le host est d’avoir LA bonne version de doc en ligne avec LA version courante du plugin.
Merci pour vos infos.
Que pensez vous de cette solution ? Qu’est ce que j’ai oublié ou que voyez vous comme soucis ?

De toute façon le market ne renvoie que vers la doc de la version stable.

Après tu peux faire autant de sites internet que tu veux de doc sinon

Ce sujet a été automatiquement fermé après 24 heures suivant le dernier commentaire. Aucune réponse n’est permise dorénavant.