Skip to content

Latest commit

 

History

History
51 lines (29 loc) · 2.46 KB

File metadata and controls

51 lines (29 loc) · 2.46 KB

🇫🇷 Français | 🇬🇧 English

Documentation Jeedom

Le site regroupant les documentations Jeedom est consultable à l'adresse suivante : https://doc.jeedom.com/home/fr_FR/.

Contribuer aux documentations

Important

Veuillez lire la page Contribuer aux documentations avant toute intervention.

Documentation générale

Les pages de documentation générale Jeedom sont directement accessibles sur ce dépôt. Chaque section dispose de son propre dossier (compatibility, contribute, dev, etc.), les contributions devant être soumises dans le dossier fr_FR de la section concernée uniquement.

Caution

Les contributions peuvent être apportées dans tous les dossiers sauf core, plugins et plugins_contributor. Ces pages sont générées depuis les dépôts du core et des plugins Jeedom, d'éventuelles modifications dans ces dossiers seraient écrasées dès le lendemain. La documentation PHPDoc est également générée automatiquement et ne doit donc pas être modifiée manuellement non plus.

Documentation du core

La documentation relative au core Jeedom (manuels d'utilisation et de configuration) se trouve dans le dossier docs/fr_FR du dépôt du core : https://github.com/jeedom/core/tree/develop/docs/fr_FR. La branche develop est à privilégier pour les contributions.

Documentation des plugins

Comme pour le core Jeedom, la documentation des plugins officiels est automatiquement générée depuis le dossier docs/fr_FR du dépôt du plugin concerné.

Contribuer au développement

Important

Veuillez lire la page Contribuer au core et aux plugins avant toute intervention.

Core

Tout comme la documentation, le core Jeedom est open source et ouvert aux contributions. L'intégralité du code est consultable à cette adresse : https://github.com/jeedom/core/tree/develop.

Sauf indication contraire, les modifications doivent impérativement être soumises sur la branche develop.

Plugins

Il est également possible de contribuer aux plugins dont les dépôts sont publics. Dans la grande majorité des cas, les modifications doivent être soumises sur la branche beta.