All plugins: Update plugin documentation: readme.md --> user_doc.rst

[bmxp]

It would be great to inspect the plugin documentation if there are old readme.md present.
In this case they should be converted from English readme.md which is deprecated to a German user_doc.rst.

---

Copied from the contribution of Morg42 (9. March 2023):

The following plugins need to be worked on as they have an existing README but no user_doc.rst:

• alexa -> marked deprecated
• apcups
• appletv
• artnet
• asterisk
• blockly
• bsblan
• buderus
• co2meter
• comfoair
• dashbutton -> not marked deprecated, but dashbuttons are not sold by Amazon any more
• datalog -> marked deprecated
• deebot_ozmo -> not marked deprecated, but the underlying Python module is not maintained any more
• easymeter -> marked deprecated
• ebus
• ecmd -> marked deprecated
• elro -> marked deprecated
• enigma2
• eta_pu
• harmony
• helios
• homeconnect
• hue
• iaqstick -> retired
• indego
• influxdata -> marked deprecated
• influxdb
• intercom_2n
• join
• jvcproj
• kathrein
• kostal
• kostalmodbus
• ksemmodbus
• logo
• luxtronic2
• mailrcv
• mailsend
• memlog -> marked deprecated
• miflora
• milight
• mlgw
• mvg_live
• nuki
• nut
• odlinfo
• operationlog -> marked deprecated
• plex
• pushbullet
• pushover
• raumfeld -> marked deprecated
• raumfeld_ng
• rcswitch
• robonect
• roomba
• roomba_980
• rrd
• rtr
• russound
• slack
• sma
• sma_em
• smarttv
• sml
• snom -> retired
• sqlite_visu2_8 -> marked deprecated
• systemair
• thz
• traffic
• trovis557x
• unifi
• volkszaehler
• vr100 -> retired
• wettercom
• withings_health
• xmpp
• zwave -> not marked deprecated, but the underlying Python module is not maintained any more

[aschwith]

Thanks for the corrections in the neato and casambi plugin docs. By the way, how can I locally build the user documentation to check if there are formal errors in those user_doc.rst files?

[msinn]

To build the documentation locally,
you need to install the requirements from doc/requirements.txt to get Sphinx going.
Afterwards simply run build_doc_local.sh from the doc directory.
The completed documentation is put under doc/user/build/html. Just load the index.html in a browser.

[Morg42]

The following plugins need to be worked on as they have an existing README but no user_doc.rst:

• alexa -> marked deprecated
• apcups
• appletv
• artnet
• asterisk
• blockly
• bsblan
• buderus
• co2meter
• comfoair
• dashbutton -> not marked deprecated, but dashbuttons are not sold by Amazon any more
• datalog
• deebot_ozmo -> not marked deprecated, but the underlying Python module is not maintained any more
• easymeter -> marked deprecated
• ebus
• ecmd -> marked deprecated
• elro -> marked deprecated
• enigma2
• eta_pu
• harmony
• helios
• homeconnect
• hue
• iaqstick
• indego
• influxdata -> marked deprecated
• influxdb
• intercom_2n
• join
• jvcproj
• kathrein
• kostal
• kostalmodbus
• ksemmodbus
• logo
• luxtronic2
• mailrcv
• mailsend
• memlog
• miflora
• milight
• mlgw
• mvg_live
• nuki
• nut
• odlinfo
• plex
• pushbullet
• pushover
• raumfeld
• raumfeld_ng
• rcswitch
• robonect
• roomba
• roomba_980
• rrd
• rtr
• russound
• slack
• sma
• sma_em
• smarttv
• sml
• snom
• sqlite_visu2_8 -> marked deprecated
• systemair
• thz
• traffic
• trovis557x
• unifi
• volkszaehler
• vr100
• wettercom
• withings_health
• xmpp
• zwave -> not marked deprecated, but the underlying Python module is not maintained any more

[bmxp]

We should exclude deprecated plugins from the need of translation an conversion, see smarthomeNG/smarthome#230

[msinn]

I have added deprecated comments and two comments, where the plugin is not deprecated but it might not be worth the effort to update the plugin

[msinn]

I copied Morg's list to the first post (to make the counters visible in the issue list).

The only changes since 9. of march are three plugins that have been retired.

[bmxp]

Ich habe mal geschaut aber nirgends eine explizite Anweisung gefunden:

Wenn user_doc.rst erstellt wurde dann readme.md löschen.

Aktuell ist z.B. im DLMS Plugin beides drin und das würde IMHO eigentlich doppelt sein, oder?

[Morg42]

Wenn readme.md deprecated ist, könnte man es dann löschen ;)

Die Informationen aus readme.md sollen ja "eingedeutscht" und in RST-Format überführt werden. Wenn also alles in user_doc.rst ist, kann die readme weg.

[bmxp]

Dann sollten wir das ggf. auch irgendwo (z.B. hier) so dokumentieren...

[msinn]

Ist der Hinweis inder Doku nicht ausreichend?

[bmxp]

Nein, da sollten wir dann schon reinschreiben das die alte Readme.md gelöscht werden soll finde ich

[msinn]

Das war von meinem Verständnis her in "überführen" impliziert.

Kann ich aber gerne noch mal explizit rein schreiben, damit es jeder merkt.

Nachtrag: Für mich besteht das Problem aber vorwiegend darin, dass keine user_doc.rst geschrieben wird und nur in Ausnahmefällen darin, dass die README.md nicht geklöcht wird nachdem alle Informationen übertragen wurden.