La documentation Jeedom est centralisée sur ce site à travers plusieurs mécanismes. Comme le core de Jeedom, la documentation est consultable sur GitHub et est Open-Source (licence MIT).
Celle-ci se découpe en trois grandes catégories :
INFORMATION
Si vous souhaitez revoir un grand nombre de fichiers, il est préférable de le faire par étape (par rubrique par exemple) plutôt que soumettre de nombreuses modifications en une seule fois.
Pour contribuer à la documentation, quelques prérequis sont à connaître et à prendre en compte :
Markdown utilisé pour la mise en forme du texte,fr_FR),.translation_memory/*.json.INFORMATION
Si vous n’êtes pas à l’aise à l’idée d’intervenir directement sur les fichiers de documentation, vous pouvez également contribuer en créant un sujet sur le forum avec l’étiquette
documentation-jeedom.
Les pages de documentation générale concernent toutes les sections, hormis celles relatives aux Manuels (core Jeedom) et aux Plugins. Les fichiers sont accessibles sur le dépôt de la documentation.
Chaque page du site de documentation correspond à un fichier Markdown (*.md) sur GitHub, par exemple :
IMPORTANT
Les documentations du core et des plugins étant génerées depuis leur propre dépôt, aucune contribution ne pourra être acceptée dans les dossiers
core,pluginsetplugins_contributor(voir paragraphes suivants). La documentationPHPDocest également générée automatiquement et ne doit donc pas être modifiée manuellement non plus.
La documentation du core Jeedom correspond aux rubriques Manuel d’utilisation et Manuel de configuration, accessibles en cliquant sur le bouton ❔ en haut à droite sur l’interface Jeedom. Les fichiers se situent sur le dépôt du core, dans le répertoire docs/fr_FR.
Chaque page de manuel correspond à un fichier Markdown (*.md) sur GitHub, par exemple :
IMPORTANT
Les contributions doivent être soumises sur la branche
developdu core.
La documentation des plugins correspond aux rubriques Plugins Officiels et Plugins Tiers. Comme leur nom l’indique, les plugins officiels sont développés par l’équipe Jeedom, les plugins tiers étant le travail de développeurs externes et indépendants.
Les plugins tiers s’occupent de générer leurs pages de documentation et de changelog par eux-mêmes, le site de documentation Jeedom recense et offre un lien d’accès direct à ces pages.
La documentation des plugins officiels est quant à elle directement récupérée depuis leurs dépôts GitHub.
INFORMATION
Certains dépôts de plugins ne sont pas accessibles publiquement. Dans ce cas, vous pouvez toujours contribuer en créant un sujet sur le forum avec l’étiquette
documentation-jeedomet celle du plugin.
Comme pour le core, chaque page de documentation d’un plugin officiel correspond à un fichier Markdown (*.md) sur GitHub. Prenons le plugin ZwaveJS pour exemple :
IMPORTANT
Les contributions doivent être soumises sur la branche
betades plugins dans la grande majorité des cas.