Skip to content

Autogenerate vehicle, meter, charger docs based on templates #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Mar 29, 2022

Conversation

naltatis
Copy link
Member

Ich hab jetzt mal einen Automatismus gebaut der die Fahrzeug, Wallbox, Hausinstallationsseite aus den Templates des Hauptprojekts generiert.

Die Templates werden bei Veränderung von evcc über eine Action zu docs gepusht. Andi hatte das damals schon so vorbereitet.

Wenn diese Änderung reingeht können wir evcc-config dann auch endlich in den wohlverdienten Ruhestand schicken und archivieren.

Das generieren findet vor dem Hochfahren/Bauen von Docosaurus statt. Hier greift also das Hotreload nicht. Sollte aber auch in der Praxis kein Problem sein, da der Template Ordner ja sowieso nicht manuell bearbeitet werden soll.

Alle Erklärungstexte und Eigenschaften (Sponsoring, 1p3p Support) zu den Geräten kommen nun aus den Template Dateien.

Bildschirmfoto 2022-03-26 um 15 44 42

Auf oberster Ebene habe ich noch einen Mechanismus eingebaut mit dem geräteübergreifende Erklärungstexte (Einführung Schaltbare Steckdosen) in die automatisch generierte Seite integriert werden können.

Bildschirmfoto 2022-03-26 um 15 45 04

Schaut gerne einmal gründlich über die Inhalte (die generierten MD Dateien sind ja auch eingecheckt). Ich hoffe ich hab nichts übersehen. Was wir momentan nicht haben ist einen Weg Grafiken pro Gerät anzuzeigen. Konkret betrifft das die Wallbe Grafik. Da müssen wir uns ggf. später was für überlegen.

@andig
Copy link
Member

andig commented Mar 27, 2022

Sieht super aus!

Was mir noch nicht so gefällt ist, dass wir alle erdenklichen Varianten ausmultiplizieren. Beispiel Wallbe- die hat genau 2 Parameter- legacy und meter. Bei uns werden daraus 2^3 Varianten weil wir auch noch die gecoverten Modell Eco und Pro unterscheiden die aber identisch sind. Vielleicht müssen wir damit aber auch einfach leben.

Alternativ: die brands in den Templates wieder rausschmeissen wo sie nicht für die Differenzierung der Funktionalität erforderlich sind. (Meinungen @naltatis @premultiply?)

@naltatis könntest Du noch einen Screenshot ergänzen wie das bei den Fahrzeugen aussieht? Oder kann ich mir das lokal anschauen?

@naltatis
Copy link
Member Author

naltatis commented Mar 27, 2022

@andig Probier mal ob npm run start bei dir läuft. Die modifizierten Templates habe ich in diesen MR händisch reimkopiert. Wenn das nicht klappt mache ich noch mehr Screenshots.

Bei uns werden daraus 2^3 Varianten weil wir auch noch die gecoverten Modell Eco und Pro unterscheiden die aber identisch sind. Vielleicht müssen wir damit aber auch einfach leben.

Generell muss mMn nicht jedes Produkt ein eigenes Template haben. Fände das durchaus ok "Wallbe Eco/Pro" da drin zu haben wenn die aus Installationssicht gleich funktionieren und keine Spezialtexte o.ä. brauchen. Das können wir ja einfach in den Templates verändern. Bei einigen Produkten ist das mMn aktuell auch schon genau so gelöst.

@premultiply
Copy link
Member

Legacy kann ganz raus. Das war nur für veraltete Firmware. Da haben wir ja neue.

Und die Frage ob Eco oder Pro ist z.B. auch der Zähler.
Aber sowas wäre wohl IMHO eigentlich besser eine Option.

@andig
Copy link
Member

andig commented Mar 27, 2022

Probier mal ob npm run start bei dir läuft. Die modifizierten Templates habe ich in diesen MR händisch reimkopiert. Wenn das nicht klappt mache ich noch mehr Screenshots.

Läuft

Generell muss mMn nicht jedes Produkt ein eigenes Template haben.

Dann könnten wir das erstmal so verwenden und müssten dann nach und nach die Templates so frisieren, dass es weniger fusselig wird. Also getrennte Themen?

Legacy kann ganz raus. Das war nur für veraltete Firmware. Da haben wir ja neue.

Das wär dann genau eine der Aufräumaktionen.

So wie das jetzt z.B. bei Audi aussieht find ichs super.

@andig
Copy link
Member

andig commented Mar 27, 2022

Können wir bei den Fahrzeugen vllt. noch Scooter und Autos differenzieren? Evtl. auch noch Services (Tronity, OVMS)? Das müsste ja ähnlich der Steckdosen möglich sein. Wär aber auch ein neues Thema.

@naltatis
Copy link
Member Author

Können wir bei den Fahrzeugen vllt. noch Scooter und Autos differenzieren? Evtl. auch noch Services (Tronity, OVMS)? Das müsste ja ähnlich der Steckdosen möglich sein. Wär aber auch ein neues Thema.

Ja, können wir, analog der Steckdosen, über das group Feld im Template im evcc Projekt machen.

@naltatis naltatis merged commit c3afc7b into main Mar 29, 2022
@delete-merged-branch delete-merged-branch bot deleted the feature/templates branch March 29, 2022 20:42
SirkoVZ pushed a commit to SirkoVZ/docs that referenced this pull request Sep 12, 2022
f72415e add victron (evcc-io#92)

git-subtree-dir: evcc-config
git-subtree-split: f72415e57f509af89d049e1bbb51064f03494c52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants