Wie kann die Dokumentation zu Solectrus noch besser werden

[GalOR7]

Ich bekenne ja ich bin ein DAU (Dümmst Anzunehmener User) 😇 was die Tiefen von Solectrus anbetrifft. Ich mache da manchmal monatelang nichts und vergesse dann natürlich wieder viele Sachen. Ich verfolge auch nicht jede Diskussion und deswegen fehlen mir auch oft die Zusammenhänge. Gerade bei "clearsky" haben mir einige Hintergründe gefehlt und dann sehe ich nur ein paar Code Snippets und habe kaum Ahnung wo ich die Sachen eintragen soll. Zumindest erschließt sich das nicht wirklich intuitiv.
Deswegen habe ich einen konkreten Vorschlag zur Verbesserung der Doku:

Ich wollte den neuen Forecast Provider pvnode in mein schon etwa 2 Jahre altes Solectrus einfügen.
Dazu habe ich diese Seite aufgerufen:
https://docs.solectrus.de/referenz/forecast-collector/allgemeine-konfiguration/
Hier steht das in die "compose.yaml" (hier geht es schon los weil ich nur eine "docker-compose.yml" habe - das kann man sicher noch kombinieren - hier ist das Gleiche gemeint
Jetzt suche ich in meiner yml die Sektion "Services" und dann suche ich den "forecast collector" - den finde ich ja noch. Aber wo ist die Sektion "Dashboard" was muss ich da einfügen?
Bei der .env auch nicht viel besser denn auch hier ist mir nicht immer klar wo die Sektionen sind.
https://docs.solectrus.de/referenz/forecast-collector/konfiguration-pvnode/

Mein Vorschlag wäre das bei den Hilfeseiten immer Verweise (gerade im Zusammenhang mit dem Snippets) auf eine komplette und aktuelle Musterdatei der yaml und .env verweisen. Idealerweise sogar mit einem Sprung in den richtigen Abschnitt der Datei.
Dann kann man bei älteren Versionen von Solectrus auch immer sehen wie aktuelle Versionen aussehen. Es ist dann ebenfalls möglich sein altes Solectrus mal auf den neuesten Stand zu bringen indem man seine wichtigen Parameter einfach überträgt und damit in Zunkunft einfacher klar kommt.

Logfiles:
Hier finde ich es wichtig immer eine Befehlszeile für die Generierung des Logs mit dazu zu schreiben. (Das machst du @ledermann ja schon ziemlich oft. Sonst muss ich immer erst alles durchsuchen bis das richtige finde.
Zumindest habe ich mir schon mal ein paar wichtige Befehlszeilen dazu abgespeichert.

Mir ist natürlich klar solche Konfigurationen werden niemals "Idiontensicher" werden. Es sind eben Sachen die mir auffallen und auch mir helfen würden.

[ledermann]

Danke für deinen ausführlichen Kommentar, ich schätze das sehr!

Vieles davon kann ich natürlich nachvollziehen, auch wenn es nicht in jedem Fall eine (einfache) Lösung gibt. Ganz konkret:

• Der Unterschied zwischen docker-compose.yml und compose.yaml wird tatsächlich bereits in der Doku beschrieben: https://docs.solectrus.de/support/docker/#und-was-ist-docker-compose (Spoiler: Es gibt keinen Unterschied)

• Da die 1.0 noch in der Beta-Phase ist, ist die Doku für das Dashboard noch auf dem Stand der v0.20.3. Ja, das ist nicht ideal, wenn man gerade pvnode eingerichtet hat und dann auch die neue Prognose-Seite sehen will, die ja Teil der 1.0 ist und neue Sensoren benötigt. Stichwort: Man kann neue Variablen definieren: INFLUX_SENSOR_OUTDOOR_TEMP, INFLUX_SENSOR_OUTDOOR_TEMP_FORECAST, INFLUX_SENSOR_INVERTER_POWER_FORECAST_CLEARSKY und noch ein paar mehr für die Wärmepumpe. Das wird natürlich alles beschrieben, wenn die 1.0 fertig ist.

• Die Doku werde ich sicherlich in der nächsten Zeit weiter verbessern. Da gibt es noch Stellen, die ich auch nicht optimal finde.

Grundsätzlich ist es sicherlich so: Solange SOLECTRUS über irgendwelche Textdateien konfiguriert wird, ist das für Laien eine schwierige Sache, bei der man Unmengen falsch machen kann. Dass man ein Grundwissen zu Linux und Docker benötigt, ist vorerst unerlässlich, so leid mir das tut.

Ein ganz spezielles Problem ist, wenn jemand noch eine sehr alte (auf SENEC gemünzte) Konfiguration hat, aus Zeiten vor v0.15 aus Juli 2024. Aber auch für die Umstellung auf die neue Konfiguration findet sich in der Doku ein Text.

Für den unbedarften User kann die Konfiguration frustrierend sein, und für mich steigt dann der Support-Aufwand immens. In einer perfekten Welt gäbe es eine komfortable Konfiguration per Browser-Oberfläche (ähnlich wie der heutige Konfigurator, aber auch für nachträgliche Änderungen geeignet). Damit spiele ich zwar gedanklich, aber das zu implementieren wäre ein immenser Aufwand. Daher wird die Doku zunächst die erste Anlaufstelle bleiben - aber sie wird besser werden, versprochen :-)