Je galère un peu avec la doc car je n’ai pas bien compris comment la générer proprement.
Ce que j’ai compris, c’est que la partie doc du plugin template est le point de depart. Cela est censé générer automatiquement des page html statiques grace à un Robot. Normalement, il faut semble-t-il activer la fonction Pages dans les réglages Github. Sauf que mon plugin etant privé je ne peux pas activer cette fonctionnalité.
J’ai trouvé le post de MIPS qui explique comment générer la DOC sur Gitlab.
Il y parle de mirrorer le dépot github vers gitlab. Or cette fonctionnalité n’est pas disponible sur Gitlab en version gratuite.
Mon dépot Github étant privé, quelle est la bonne solution pour publier la doc?
Salut,
gitlab permet toujours de générer la doc sur un dépot privé (gratuitement) par contre ils ont coupé le mirroring sur les comptes gratuit, donc cette technique ne fonctionne plus.
Perso j’ai, comme beaucoup, viré toute la doc de mes plugins et tout déplacé la partie doc sur un dépôt public (sur github); c’est la seule option viable pour l’instant je pense.
Le désavantage de cette option c’était qu’il était impossible de bénéficier du système de traduction proposé par Jeedom ainsi que du lien sur le site de doc général de jeedom mais vu que cette partie est cassée aussi (pour le moment), cela n’a plus vraiment d’importance.
Un avantage par contre c’est que les plugins sur le market prennent beaucoup moins de place évidement car il n’y a plus cette doc inutile à cet endroit.
J’ai également réintégré mon dépot de doc à transifex (sous ma propre organisation du coup), ca marche très bien; évidement je ne sais traduire qu’en Anglais et je n’ai personne qui collabore
Merci… Je vais créer un dépot publique pour la doc. Par contre je galère pour comprendre comment ca marche et je ne vois pas du tout quelle est la marche à suivre?
la procédure est déjà documentée: https://jeedom.github.io/documentation/dev/fr_FR/documentation_plugin
sauf qu’au lieu de faire la génération depuis le dossier docs tu peux le faire depuis le root
et la dernière étape, génération de la traduction, n’est plus applicable car cela ne fonctionne plus.
Ça marche avoir GitHub pages sur un repo privé.
Pour comprendre comment marche le concept c’est ça le mot magique : GitHub pages. C’est le moteur de production des pages web, avec ça tu trouveras les possibilités (depuis répertoire, depuis la racine …)
Après un dépôt public pour les docs, c’est mieux pour pas mal de point, c’est le choix que j’ai fait pour regrouper toutes les docs, plugins publics ou privés
Bonjour,
Toujours très lourd car full manuel, inconcevable des que plus d’un plug-in.
Et de toute façon ça ne sert plus à rien puisqu’il n’y a plus de système de traduction (pour l’instant)
