Zur Dokumentation beitragen

Die Jeedom-Dokumentation ist auf dieser Website über verschiedene Mechanismen zentralisiert. Wie der Kern von Jeedom, Die Dokumentation ist auf GitHub einsehbar und ist Open-Source (MIT-Lizenz).

Diese lässt sich in drei große Kategorien unterteilen:

• Allgemeine Dokumentation
• Die Dokumentation zum Jeedom-Core
• Die Dokumentation zu den Plugins

INFORMATION

Wenn Sie eine große Anzahl von Dateien überprüfen möchten, ist es ratsam, dies schrittweise (beispielsweise nach Rubriken) zu tun, anstatt zahlreiche Änderungen auf einmal einzureichen.

Voraussetzungen

Um zur Dokumentation beizutragen, sollten Sie einige Voraussetzungen kennen und berücksichtigen:

• Zunächst einmal muss man überein Benutzerkonto auf GitHub,
• Know-how ein Pull Request auf GitHub,
• Wissenswertes die Sprache Markdown wird zur Formatierung des Textes verwendet,
• Da die Übersetzungen aus dem Französischen erstellt werden, müssen die Beiträge unbedingt auf Französisch eingereicht werden (Ordner fr_FR),
• Da die Übersetzungen automatisch generiert werden, dürfen an den Dateien keine Änderungen vorgenommen werden .translation_memory/*.json**.

INFORMATION

Wenn Sie sich nicht wohl dabei fühlen, direkt in den Dokumentationsdateien Änderungen vorzunehmen, können Sie auch einen Beitrag leisten, indem Sie ein Thema erstellen unter das Forum mit dem Etikett documentation-jeedom.

Allgemeine Dokumentation

Die Seiten mit der allgemeinen Dokumentation beziehen sich auf alle Abschnitte, mit Ausnahme derjenigen, die sich auf Handbücher (Jeedom-Kern) und Plugins beziehen. Die Dateien sind abrufbar unter das Dokumentations-Repository.

Jede Seite der Dokumentationswebsite entspricht einer Datei Markdown (*.md) auf GitHub, zum Beispiel:

• Diese Seite, Zur Dokumentation beitragen (doc.jeedom.com/contribute/#LANG#/doc) entspricht der Datei contribute/fr_FR/doc.md.
• Die Seite Kompatibilität (doc.jeedom.com/compatibility/#LANG#/) entspricht der Datei Kompatibilität/fr_FR/index.md.
• Die Seite Installation auf dem Raspberry Pi (doc.jeedom.com/installation/#LANG#/rpi) entspricht der Datei Installation/fr_FR/rpi.md.
• Die Seite Plugin-Entwicklung (doc.jeedom.com/dev/#LANG#/) entspricht der Datei dev/fr_FR/index.md.
• Und so weiter…

WICHTIG

Da die Dokumentationen für den Core und die Plugins aus deren eigenen Repositories generiert werden, können keine Beiträge in den Ordnern akzeptiert werden core, plugins und plugins_contributor (siehe folgende Absätze). Die Dokumentation PHPDoc wird ebenfalls automatisch generiert und muss daher auch nicht manuell geändert werden.

Jeedom-Core-Dokumentation

Die Dokumentation zum Jeedom-Core umfasst die Rubriken Bedienungsanleitung und Konfigurationshandbuch, die Sie durch Klicken auf die Schaltfläche ❔ oben rechts auf der Jeedom-Benutzeroberfläche aufrufen können. Die Dateien befinden sich unter Das Core-Repository, im Verzeichnis docs/fr_FR.

Jede Seite des Handbuchs entspricht einer Datei Markdown (*.md) auf GitHub, zum Beispiel:

• Bedienungsanleitung – Dashboard (doc.jeedom.com/core/#VERSION#/#LANG#/dashboard) entspricht der Datei docs/fr_FR/dashboard.md.
• Bedienungsanleitung – Szenarien (doc.jeedom.com/core/#VERSION#/#LANG#/scenario) entspricht der Datei docs/fr_FR/scenario.md.
• Konfigurationshandbuch – Erweiterte Anpassung (doc.jeedom.com/core/#VERSION#/#LANG#/custom) entspricht der Datei docs/fr_FR/custom.md.

WICHTIG

Beiträge müssen über den Zweig eingereicht werden develop vom Kern aus.

Plugin-Dokumentation

Die Dokumentation zu den Plugins ist in die Rubriken Offizielle Plugins und Plugins von Drittanbietern unterteilt. Wie der Name schon sagt, werden die offiziellen Plugins vom Jeedom-Team entwickelt, während die Plugins von Drittanbietern das Werk externer und unabhängiger Entwickler sind.

Plugins von Drittanbietern erstellen ihre Dokumentations- und Changelog-Seiten selbst; die Jeedom-Dokumentationsseite listet diese Seiten auf und bietet einen direkten Link zu ihnen.

Die Dokumentation der offiziellen Plugins wird hingegen direkt aus deren GitHub-Repositories abgerufen.

INFORMATION

Einige Plugin-Repositorien sind nicht öffentlich zugänglich. In diesem Fall können Sie dennoch einen Beitrag leisten, indem Sie ein Thema erstellen unter das Forum mit dem Etikett documentation-jeedom und die des Plugins.

Wie beim Core entspricht jede Dokumentationsseite eines offiziellen Plugins einer Datei Markdown (*.md) auf GitHub. Nehmen wir das ZwaveJS-Plugin als Beispiel:

• Dokumentation zum Z-Wave-JS-Plugin (doc.jeedom.com/plugins/automation%20protocol/zwavejs/beta/#LANG#/) entspricht der Datei docs/fr_FR/index.md.
• Änderungsprotokoll des Z-Wave-JS-Plugins (doc.jeedom.com/plugins/automation%20protocol/zwavejs/beta/#LANG#/changelog) entspricht der Datei docs/fr_FR/changelog.md.

WICHTIG

Beiträge müssen über den Zweig eingereicht werden beta Plugins in den allermeisten Fällen.