Herstarten processen verduidelijken in docs #1310

docs/changelog.rst

@@ -29,6 +29,7 @@ v4.13.0 - 2021-xx-xx
 - ``Fixed``: Schoonheidsfoutje op de statistieken pagina [`#1305 <https://github.com/dsmrreader/dsmr-reader/issues/1305>`_]
 - ``Fixed``: Bestaande superusers uitschakelen bij uitvoeren "dsmr_superuser" command [`#1309 <https://github.com/dsmrreader/dsmr-reader/issues/1309>`_]
 - ``Fixed``: E-mailverzending timeout [`#1310 <https://github.com/dsmrreader/dsmr-reader/issues/1310>`_]
+- ``Fixed``: Herstarten processen verduidelijken in docs [`#1310 <https://github.com/dsmrreader/dsmr-reader/issues/1310>`_]
 
 
 v4.12.0 - 2021-02-17

docs/faq.rst

@@ -103,7 +103,10 @@ This applies **specifically** to the ``dsmr_backend`` process.
 
 The DEBUG-logging is disabled by default, to reduce writes on the filesystem. You can enable the logging by following these steps:
 
-* Make sure you are ``dsmr`` user by executing ``sudo su - dsmr``.
+* Make sure you are ``dsmr`` user by executing::
+
+    sudo su - dsmr
+
 * Open the ``.env`` file and look for the code below::
 
     ### Logging level.
@@ -117,13 +120,12 @@ The DEBUG-logging is disabled by default, to reduce writes on the filesystem. Yo
 
     DSMRREADER_LOGLEVEL=DEBUG
 
-* After editing the file, all processes need to be restarted. To do this, you can either execute::
+* After editing the file, all processes need to be restarted to reflect the change. Go back to the **root user or sudoer** with::
 
-    ./post-deploy.sh
+    logout
 
-* Or go back to the **sudo user** and execute::
+* And restart::
 
-    CTRL+D
     sudo supervisorctl restart all
 
 * All done!

docs/locale/nl/LC_MESSAGES/plugins.po

@@ -9,7 +9,7 @@ msgstr ""
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=utf-8\n"
 "Content-Transfer-Encoding: 8bit\n"
-"Generated-By: Babel 2.8.0\n"
+"Generated-By: Babel 2.9.0\n"
 "X-Generator: Poedit 2.0.6\n"
 
 #: ../../plugins.rst:2
@@ -53,142 +53,145 @@ msgid "Your plugin file is imported once, so you should make sure to hook any ev
 msgstr "Je plugin-bestand wordt eenmalig geimporteerd, dus zorg ervoor dat je gebeurtenissen koppelt die je wilt volgen."
 
 #: ../../plugins.rst:26
-msgid "And finally, make sure to **reload the application** by deploying it again. You can do that by simply executing the ``post-deploy.sh`` script in the root of the project."
-msgstr "En tot slot, zorg ervoor dat je **de applicatie herlaadt** door opnieuw te deployen. Je kunt dat doen door simpelweg ``post-deploy.sh`` uit te voeren, het script in de root van het project."
+msgid "And finally, make sure to **restart the application** to reflect the changes. Do so by executing the following as **root user or sudoer**::"
+msgstr "Tot slot, zorg ervoor dat je **de applicatie herstart** om de wijzigingen door te voeren. Voer als **root of sudo-gebruiker** dit uit::"
 
-#: ../../plugins.rst:30
+#: ../../plugins.rst:33
 msgid "Events / Signals"
 msgstr "Gebeurtenissen / Signalen"
 
-#: ../../plugins.rst:31
+#: ../../plugins.rst:34
 msgid "These are either dispatched by the Django framework or the application at some point."
 msgstr "Deze worden verstuurd door ofwel het Django framework ofwel de applicatie zelf."
 
-#: ../../plugins.rst:34
+#: ../../plugins.rst:37
 msgid "``dsmr_backend.signals.backend_called``"
 msgstr "``dsmr_backend.signals.backend_called``"
 
-#: ../../plugins.rst:36
+#: ../../plugins.rst:39
 msgid "Called by each iteration of the backend. Please use with caution, as it may block all backend operations when used improperly."
 msgstr "Aangeroepen bij elke iteratie van de backend. Gebruik dit terughoudend, gezien het alle backend-acties kan blokkeren wanneer het verkeerd gebruikt wordt."
 
-#: ../../plugins.rst:40
+#: ../../plugins.rst:43
 msgid "``dsmr_pvoutput.signals.pvoutput_upload``"
 msgstr "``dsmr_pvoutput.signals.pvoutput_upload``"
 
-#: ../../plugins.rst:41
+#: ../../plugins.rst:44
 msgid "Called by dsmr_pvoutput just before uploading data to PVOutput. The ``data`` kwarg contains the data to be sent."
 msgstr "Aangeroepen door dsmr_pvoutput vlak voor het uploaden van gegevens naar PVOutput. De ``data`` kwarg bevat de gegevens die verstuurd worden."
 
-#: ../../plugins.rst:45
+#: ../../plugins.rst:48
 msgid "``dsmr_datalogger.signals.raw_telegram``"
 msgstr "``dsmr_datalogger.signals.raw_telegram``"
 
-#: ../../plugins.rst:46
+#: ../../plugins.rst:49
 msgid "Called by dsmr_datalogger when receiving or reading a telegram string. The ``data`` kwarg contains the raw telegram string."
 msgstr "Aangeroepen door dsmr_datalogger wanneer er een telegram ontvangen of uitgelezen wordt. De ``data`` kwarg bevat de ruwe string met het telegram."
 
-#: ../../plugins.rst:50
+#: ../../plugins.rst:53
 msgid "``dsmr_notification.signals.notification_sent``"
 msgstr "``dsmr_notification.signals.notification_sent``"
 
-#: ../../plugins.rst:51
+#: ../../plugins.rst:54
 msgid "Called by dsmr_notification just after dispatching a notification. The ``title`` kwarg contains the notification title, ``message`` contains the message body."
 msgstr "Aangeroepen door dsmr_notification vlak nadat een notificatie verstuurd wordt. De ``title`` kwarg bevat de titel van de notificatie, ``message`` bevat het inhoudelijke bericht."
 
-#: ../../plugins.rst:55
+#: ../../plugins.rst:58
 msgid "``django.db.models.signals.post_save``"
 msgstr "``django.db.models.signals.post_save``"
 
-#: ../../plugins.rst:56
+#: ../../plugins.rst:59
 msgid "Called by Django after saving new records to the database. Can be bound to the ``DayStatistics`` model for example, to process daily statistics elsewhere."
 msgstr "Aangeroepen door Django bij het opslaan van nieuwe databaserecords. Kan gekoppeld worden aan bijvoorbeeld het ``DayStatistics`` model, om dagelijkse statistieken ergens anders te verwerken."
 
-#: ../../plugins.rst:60
+#: ../../plugins.rst:63
 msgid "Other"
 msgstr "Overige"
 
-#: ../../plugins.rst:61
+#: ../../plugins.rst:64
 msgid "More signals may be available for use, please be careful when binding Django save-signals as it may impact performance."
 msgstr "Meer signalen/gebeurtenissen zijn beschikbaar voor gebruik, echter wees voorzichtig bij het gebruiken van Django save-signalen, aangezien het de performance kan beïnvloeden."
 
-#: ../../plugins.rst:65
+#: ../../plugins.rst:68
 msgid "Examples:"
 msgstr "Voorbeelden:"
 
-#: ../../plugins.rst:68
+#: ../../plugins.rst:71
 msgid "Example #1: Upload data to second PVOutput account"
 msgstr "Voorbeeld #1: Upload gegevens naar een tweede PVOutput-account"
 
-#: ../../plugins.rst:69
+#: ../../plugins.rst:72
 msgid "This is an example of issue `#407 <https://github.com/dsmrreader/dsmr-reader/issues/407>`_, requesting the feature to upload data to a second PVOuput account."
 msgstr "Dit is een voorbeeld van issue `#407 <https://github.com/dsmrreader/dsmr-reader/issues/407>`_, met het verzoek om gegevens te uploaden naar een tweede PVOutput-account."
 
-#: ../../plugins.rst:73 ../../plugins.rst:115 ../../plugins.rst:168
-#: ../../plugins.rst:215 ../../plugins.rst:261
+#: ../../plugins.rst:76 ../../plugins.rst:118 ../../plugins.rst:171
+#: ../../plugins.rst:218 ../../plugins.rst:264
 msgid ":doc:`DSMRREADER_PLUGINS configuration<env_settings>`::"
 msgstr ":doc:`DSMRREADER_PLUGINS configuratie<env_settings>`::"
 
-#: ../../plugins.rst:78
+#: ../../plugins.rst:81
 msgid "Plugin file ``dsmr_plugins/modules/secondary_pvoutput_upload.py`` (new file)::"
 msgstr "Plugin bestand ``dsmr_plugins/modules/secondary_pvoutput_upload.py`` (nieuw bestand)::"
 
-#: ../../plugins.rst:106
+#: ../../plugins.rst:109
 msgid "Note that the ``XXXXX`` and ``YYYYY`` variables should be replace by your second set of PVOutput API credentials."
 msgstr "N.B.: De variablen ``XXXXX`` en ``YYYYY`` vervang je door de API-credentials van je tweede PVOutput-account."
 
-#: ../../plugins.rst:110
+#: ../../plugins.rst:113
 msgid "Example #2: Forwarding raw telegram data to another serial port"
 msgstr "Voorbeeld #2: Doorsturen van ruwe telegram-gegevens naar een andere seriële poort"
 
-#: ../../plugins.rst:111
+#: ../../plugins.rst:114
 msgid "This is an example of issue `#557 <https://github.com/dsmrreader/dsmr-reader/issues/557>`_, allowing raw DSMR telegrams to be forwarded to another serial port."
 msgstr "Dit is een voorbeeld van issue `#557 <https://github.com/dsmrreader/dsmr-reader/issues/557>`_, wat ervoor zorgt dat je DSMR-telegrammen kunt doorsturen naar een andere seriële poort."
 
-#: ../../plugins.rst:120
+#: ../../plugins.rst:123
 msgid "Plugin file ``dsmr_plugins/modules/forward_raw_telegram_to_serial.py`` (new file)::"
 msgstr "Plugin bestand ``dsmr_plugins/modules/forward_raw_telegram_to_serial.py`` (nieuw bestand)::"
 
-#: ../../plugins.rst:159
+#: ../../plugins.rst:162
 msgid "Note that the ``/dev/ttyUSBvA`` variable should be changed to the serial port used in your own situation."
 msgstr "N.B.: Je moet de ``/dev/ttyUSBvA`` variabele nog wijzigen naar de juiste seriële poort in je eigen situatie."
 
-#: ../../plugins.rst:163
+#: ../../plugins.rst:166
 msgid "Example #3: Forwarding raw telegram data to another instance by API"
 msgstr "Voorbeeld #3: Doorsturen van ruwe telegram-gegevens naar een andere instantie van DSMR-reader, via de API"
 
-#: ../../plugins.rst:164
+#: ../../plugins.rst:167
 msgid "This can be quite handy if you run multiple instances of DSMR-reader (i.e.: RaspberryPI + somewhere in cloud)."
 msgstr "Dit kan behoorlijk handig zijn wanneer je meerdere instanties van DSMR-reader draait (bijvoorbeeld op een Raspberry en gespiegeld in de cloud)."
 
-#: ../../plugins.rst:173
+#: ../../plugins.rst:176
 msgid "Plugin file ``dsmr_plugins/modules/forward_raw_telegram_to_api.py`` (new file)::"
 msgstr "Plugin bestand ``dsmr_plugins/modules/forward_raw_telegram_to_api.py`` (nieuw bestand)::"
 
-#: ../../plugins.rst:206
+#: ../../plugins.rst:209
 msgid "Note that the ``API_HOST``, ``API_KEY`` and ``TIMEOUT`` variables should be changed to your own preferences."
 msgstr "N.B.: De ``API_HOST``, ``API_KEY`` en ``TIMEOUT`` variabelen moet je nog wijzigen naar je eigen voorkeuren."
 
-#: ../../plugins.rst:210
+#: ../../plugins.rst:213
 msgid "Example #4: Forwarding DSMR readings in JSON format to some API"
 msgstr "Voorbeeld #4: Doorsturen van DSMR-metingen in JSON-formaat naar een API"
 
-#: ../../plugins.rst:211
+#: ../../plugins.rst:214
 msgid "Use this to send DSMR readings in JSON format to some (arbitrary) API."
 msgstr "Gebruik dit om DSMR-metingen in JSON-formaat naar een (willekeurige) API door te sturen."
 
-#: ../../plugins.rst:220
+#: ../../plugins.rst:223
 msgid "Plugin file ``dsmr_plugins/modules/forward_json_dsmrreading_to_api.py`` (new file)::"
 msgstr "Plugin bestand ``dsmr_plugins/modules/forward_json_dsmrreading_to_api.py`` (nieuw bestand)::"
 
-#: ../../plugins.rst:257
+#: ../../plugins.rst:260
 msgid "Example #5: Read telegrams using DSMRloggerWS API"
 msgstr "Voorbeeld #5: Lees telegrammen uit de DSMRloggerWS API"
 
-#: ../../plugins.rst:266
+#: ../../plugins.rst:269
 msgid "Plugin file ``dsmr_plugins/modules/poll_dsmrloggerws_api.py`` (new file)::"
 msgstr "Plugin bestand ``dsmr_plugins/modules/poll_dsmrloggerws_api.py`` (nieuw bestand)::"
 
-#: ../../plugins.rst:297
+#: ../../plugins.rst:300
 msgid "Note that you might need to update the ``http://localhost`` value to your own situation."
 msgstr "Let op dat je mogelijk de waarde van ``http://localhost`` moet bijwerken naar je eigen situatie."
+
+#~ msgid "And finally, make sure to **reload the application** by deploying it again. You can do that by simply executing the ``post-deploy.sh`` script in the root of the project."
+#~ msgstr "En tot slot, zorg ervoor dat je **de applicatie herlaadt** door opnieuw te deployen. Je kunt dat doen door simpelweg ``post-deploy.sh`` uit te voeren, het script in de root van het project."

docs/plugins.rst

@@ -23,7 +23,10 @@ Please make sure the ``plugin_name``,
 
 Your plugin file is imported once, so you should make sure to hook any events you want.
 
-And finally, make sure to **reload the application** by deploying it again. You can do that by simply executing the ``post-deploy.sh`` script in the root of the project.
+And finally, make sure to **restart the application** to reflect the changes.
+Do so by executing the following as **root user or sudoer**::
+
+    sudo supervisorctl restart all
 
 
 Events / Signals