Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
msinn committed Sep 14, 2023
1 parent 3955452 commit f4337bd
Showing 1 changed file with 21 additions and 4 deletions.
25 changes: 21 additions & 4 deletions doc/user/source/beispiele/plugins/plugin_aus_develop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,28 @@ Das Skript für Installation wird folgendermaßen gestartet:
|
Konfiguration anpassen
----------------------

Um das neue Plugin zu aktivieren, muss noch die Plugin Konfiguration in der Datei ``etc/plugin.yaml`` angepasst werden.
Dazu muss im Abschnitt in dem das Plugin konfiguriert ist, der Eintrag ``plugin_name: xyz`` durch
``plugin_name: xyz_dev`` ersetzt werden.

Falls ein Logger für das ursprüngliche Plugin **xyz** konfiguriert ist, muss auch noch in ``etc/logging.yaml`` ein
Logger für das Plugin **xyz_dev** konfiguriert werden. Dazu einfach den Abschnitt mit dem Logger ``plugins.xyz``
kopieren und in der Kopie den Namen in ``plugins.xyz_dev`` ändern.

|
Plugin manuell installieren
===========================
---------------------------

Alternativ kann das Plugin manuell installiert werden. Im folgenden wird ein mögliches Vorgehen beschrieben,
um ein Plugin aus dem develop Branch in eine Release Installation zu installieren. Dazu sind folgende Schritte
durchzuführen:

Plugins Repository aufrufen
---------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Im Browser die Seite http://www.github.com/smarthomeng/plugins aufrufen:

Expand All @@ -46,21 +59,22 @@ und in den develop Branch wechseln:
|
Plugins Repository Download
---------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Anschließend auf den grünen **Code** Button klicken und **Download ZIP** auswählen:

.. image:: ../assets/plugin_install_3.jpg
:class: screenshot


|
Falls der Browser das ZIP Archiv nicht bereits entpackt hat, das Archiv ``plugins-develop.zip`` entpacken.

|
Gewünschtes Plugin installieren
-------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Um zum Beispiel ein Plugin mit dem Namen **xyz** aus dem develop Branch zu installieren, sollte (falls es existiert)
zuerst das Verzeichnis **xyz_dev** im ``plugins`` Verzeichnis gelöscht werden, damit keine Seiteneffekte durch
Expand All @@ -72,6 +86,9 @@ kopiert werden.

Nun kann das Archiv ``develop.zip`` und das Verzeichnis ``plugins-develop`` gelöscht werden.

Konfiguration anpassen
^^^^^^^^^^^^^^^^^^^^^^

Um das neue Plugin zu aktivieren, muss noch die Plugin Konfiguration in der Datei ``etc/plugin.yaml`` angepasst werden.
Dazu muss im Abschnitt in dem das Plugin konfiguriert ist, der Eintrag ``plugin_name: xyz`` durch
``plugin_name: xyz_dev`` ersetzt werden.
Expand Down

0 comments on commit f4337bd

Please sign in to comment.