La documentación de Jeedom está centralizada en esta web a través de varios mecanismos. Al igual que el núcleo de Jeedom, La documentación está disponible en GitHub y es de código abierto (licencia MIT).
Esta se divide en tres grandes categorías:
INFORMACIÓN
Si quieres revisar un gran número de archivos, es mejor hacerlo por etapas (por sección, por ejemplo) en lugar de enviar muchas modificaciones de una sola vez.
Para contribuir a la documentación, hay que conocer y tener en cuenta algunos requisitos previos:
Markdown utilizado para dar formato al texto,fr_FR),.translation_memory/*.json.INFORMACIÓN
Si no te sientes cómodo modificando directamente los archivos de documentación, también puedes colaborar creando un tema en el foro con la etiqueta
documentation-jeedom.
Las páginas de documentación general abarcan todas las secciones, salvo las relativas a los Manuales (Jeedom core) y a los Plugins. Se puede acceder a los archivos en el repositorio de la documentación.
Cada página del sitio web de documentación corresponde a un archivo Markdown (*.md) en GitHub, por ejemplo:
IMPORTANTE
Dado que la documentación del núcleo y de los complementos se genera desde su propio repositorio, no se aceptarán contribuciones en las carpetas
core,pluginsyplugins_contributor(véanse los párrafos siguientes). La documentaciónPHPDoctambién se genera automáticamente, por lo que tampoco es necesario modificarla manualmente.
La documentación del núcleo de Jeedom se encuentra en las secciones Manual de usuario y Manual de configuración, a las que se puede acceder haciendo clic en el botón ❔ situado en la esquina superior derecha de la interfaz de Jeedom. Los archivos se encuentran en el repositorio del núcleo, en el directorio docs/fr_FR.
Cada página del manual corresponde a un archivo Markdown (*.md) en GitHub, por ejemplo:
IMPORTANTE
Las contribuciones deben enviarse a la rama
developdesde la base.
La documentación de los complementos se divide en las secciones Complementos oficiales y Complementos de terceros. Como su nombre indica, los complementos oficiales los desarrolla el equipo de Jeedom, mientras que los complementos de terceros son obra de desarrolladores externos e independientes.
Los complementos de terceros se encargan de generar por sí mismos sus páginas de documentación y de registro de cambios; la página web de documentación de Jeedom las recoge y ofrece un enlace de acceso directo a dichas páginas.
Por su parte, la documentación de los complementos oficiales se obtiene directamente de sus repositorios de GitHub.
INFORMACIÓN
Algunos repositorios de plugins no son de acceso público. En ese caso, siempre puedes colaborar creando un tema en el foro con la etiqueta
documentation-jeedomy la del complemento.
Al igual que en el núcleo, cada página de documentación de un complemento oficial corresponde a un archivo Markdown (*.md) en GitHub. Tomemos como ejemplo el plugin ZwaveJS:
IMPORTANTE
Las contribuciones deben enviarse a la rama
betaplugins en la gran mayoría de los casos.