diff --git a/astro.config.mjs b/astro.config.mjs index 2c83c4ac9..374736e1f 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -343,6 +343,11 @@ export default defineConfig({ translations: { de: "Problem melden" }, slug: "report-a-problem", }, + { + label: "Contribute", + translations: { de: "Mitmachen" }, + slug: "contribute", + }, { slug: "sponsorship" }, ], }), diff --git a/src/content/docs/de/contribute.mdx b/src/content/docs/de/contribute.mdx new file mode 100644 index 000000000..a672487b6 --- /dev/null +++ b/src/content/docs/de/contribute.mdx @@ -0,0 +1,83 @@ +--- +title: "Mitmachen" +description: "Zeigt, wie du helfen kannst, indem du Fragen beantwortest, Nightly- und PR-Builds testest, eigene Geräte einbindest, übersetzt, die Doku verbesserst oder Code schreibst." +--- + +evcc wird von der Community entwickelt. +Für die meisten Beiträge brauchst du keinen Code. + +## Klein anfangen \{#start} + +Fang nicht mit deinem großen Lieblingsfeature an, auch wenn KI-Agenten das unglaublich einfach und verlockend machen. +Lies erst eine Weile in den [Discussions](https://github.com/evcc-io/evcc/discussions) und [Issues](https://github.com/evcc-io/evcc/issues) mit und bekomm ein Gefühl dafür, wie die Community tickt. +Deine Idee kam wahrscheinlich schon mal auf, also such danach und steig in die bestehende Diskussion ein. +Ein kleiner erster Beitrag ist der beste Einstieg, alles Weitere ergibt sich mit der Zeit. +Größere Änderungen brauchen Einigkeit in einem Issue oder einer Diskussion, bevor es an die Umsetzung und den Pull Request geht. + +## Anderen helfen \{#help} + +Viele Fragen in den [Discussions](https://github.com/evcc-io/evcc/discussions/categories/need-help) kann jemand beantworten, der das gleiche Gerät besitzt oder das gleiche Problem hatte. +Auch beim Sortieren kannst du helfen: gemeldete Fehler nachstellen, fehlende Logs anfragen und auf Duplikate hinweisen. +[Problem melden](/de/report-a-problem) erklärt, was ein hilfreiches Issue enthält. + +## Neue Versionen testen \{#testing} + +Die Nightly-Version enthält alles, was seit dem letzten Release gemergt wurde. +Alle Installationsanleitungen (z. B. [Linux](/de/installation/linux), [Docker](/de/installation/docker) oder [Home Assistant](/de/installation/home-assistant)) erklären, wie du sie installierst. +Mach vor dem Wechsel ein Backup deiner Installation. +Neue Funktionen starten oft als experimentell und müssen unter **Konfiguration → Experimentell** aktiviert werden. + +Für einen Pull Request können Maintainer einen Test-Build mit Binaries und einem Docker-Image `evcc/evcc:pr-` bereitstellen. +Ein kurzer Testbericht von jemandem mit passender Hardware bringt eine Änderung oft erst ins Ziel. +Hat ein Pull Request noch keinen Test-Build und du könntest ihn testen, frag dort gerne danach. + +Wie du neue Versionen der iOS- und Android-App vorab testest, steht im [Beta-Abschnitt der App](https://github.com/evcc-io/app#beta-testing). + +## Deine eigenen Geräte \{#devices} + +Die besten ersten Beiträge kommen aus deinem eigenen Setup. +Du besitzt einen Wechselrichter, eine Hausbatterie, ein Fahrzeug oder eine Wallbox, die die Maintainer nicht testen können. +Bestätige Fehlerbehebungen oder verbessere die Hinweise eines Templates. +Dein Gerät wird noch nicht unterstützt? Binde es zuerst als [benutzerdefiniertes Gerät](/de/user-defined-devices) ein und mach daraus, sobald es läuft, ein Template für alle. + +## Übersetzen \{#translate} + +Die Oberfläche wird auf [Weblate](https://hosted.weblate.org/engage/evcc/) übersetzt. +Füge eine neue Sprache hinzu oder prüfe und verbessere eine bestehende, ganz ohne Entwicklerwerkzeuge. + +## Doku verbessern \{#docs} + +Jede Seite hat unten einen Link **Seite bearbeiten**, der zur Quelle auf GitHub führt. +Die Dokumentation gibt es auf Deutsch und Englisch. +Wenn du nur eine der Sprachen sprichst, schreib das in deinen Pull Request und wir helfen bei der anderen. + +## Code schreiben \{#code} + +Die [Contribution Guidelines](https://github.com/evcc-io/evcc/blob/master/CONTRIBUTING.md) beschreiben die Grundregeln, die Entwicklungsumgebung und wie du lokal testest. +Allgemeine Entwicklungsthemen besprechen wir auf [Slack](https://evcc.io/slack). + +## Eigene Projekte rund um evcc \{#build} + +Dashboards, Displays, Tools oder Hardware-Gadgets, die anderen Nutzern helfen, sind ebenfalls ein Beitrag. +Über die [REST-API](/integrations/rest-api) und [MQTT-API](/de/integrations/mqtt-api) kommst du an alle Daten deiner evcc-Instanz. +Stell dein Projekt in den Discussions vor und trag es unter [More Awesome Projects](/de/smarthome/awesome) ein. + +## Projektübersicht \{#projects} + +| Repository | Was es ist | Technik | +| --------------------------------------------------------------- | ----------------------------------------------- | --------------- | +| [evcc-io/evcc](https://github.com/evcc-io/evcc) | Kern, Weboberfläche und Geräte-Templates | Go, Vue | +| [evcc-io/app](https://github.com/evcc-io/app) | iOS- und Android-App | React Native | +| [evcc-io/optimizer](https://github.com/evcc-io/optimizer) | [Optimizer](/de/features/optimizer)-Dienst | Python | +| [evcc-io/docs](https://github.com/evcc-io/docs) | Diese Dokumentation | Astro, Markdown | +| [evcc-io/images](https://github.com/evcc-io/images) | Linux-Images für Raspberry Pi und andere Boards | Armbian | +| [evcc-io/hassio-addon](https://github.com/evcc-io/hassio-addon) | Home Assistant App | Docker | +| [evcc-io/evcc.io](https://github.com/evcc-io/evcc.io) | Website | Hugo | + +[Problem melden](/de/report-a-problem#where) zeigt, in welches Repository ein Problem gehört. + +## Contributor-Token \{#token} + +Das Projekt lebt von der Mitarbeit vieler Menschen, mit Code, Templates, Doku, Übersetzungen, Antworten in den Discussions oder ausführlichen Testberichten. + +Du hast schon einiges beigetragen? [Schreib uns eine kurze Mail](mailto:info@evcc.io) mit deinem GitHub-Namen und wir stellen dir ein unbefristetes Unterstützertoken aus. diff --git a/src/content/docs/de/index.mdx b/src/content/docs/de/index.mdx index 6aa6ca91a..fe14da6f4 100644 --- a/src/content/docs/de/index.mdx +++ b/src/content/docs/de/index.mdx @@ -122,7 +122,6 @@ evcc kommt ohne jede Art von Garantie. Du verwendest die Software auf eigenes Ri ## Triff die Community - Support, Konfiguration, Fragen zu Geräten: [Community Support Forum](https://github.com/evcc-io/evcc/discussions) -- Schnell Hilfe bekommen und Probleme gut beschreiben: [Problem melden](/de/report-a-problem) -- Chat zu Entwicklungsthemen: [Slack](https://evcc.io/slack) +- Selbst mitmachen, mit oder ohne Code: [Mitmachen](/de/contribute) Du willst mehr? Schau bei [Vorträge, Videos & Blogs](/de/media) vorbei. diff --git a/src/content/docs/de/sponsorship.mdx b/src/content/docs/de/sponsorship.mdx index e39118887..76aec7593 100644 --- a/src/content/docs/de/sponsorship.mdx +++ b/src/content/docs/de/sponsorship.mdx @@ -58,14 +58,10 @@ Als kleines Dankeschön wird in der evcc UI **digitales Supporter-Konfetti 🎉* ## Contributor-Token -Du hast Lust, an der Entwicklung mitzuwirken? -Wir freuen uns über jeden Beitrag. -Schau dir gerne die Liste an [offenen GitHub Issues](https://github.com/evcc-io/evcc/issues) an oder [melde dich bei uns](mailto:info@evcc.io) mit konkreten Ideen, an denen du gerne mitarbeiten möchtest. -Auch signifikante Beiträge zur [Dokumentation](https://github.com/evcc-io/docs) oder [Übersetzung](https://github.com/evcc-io/evcc/blob/master/CONTRIBUTING.md#adding-or-modifying-translations) qualifizieren für ein Contributor-Token. -[Hier](https://github.com/evcc-io/evcc/blob/master/CONTRIBUTING.md) findest du weitere Informationen, wie du loslegen kannst. - -Als Contributor zum Projekt stellen wir dir gerne ein unbefristetes Unterstützertoken aus. -Schreib uns dafür [eine kurze Mail](mailto:info@evcc.io) mit deinem GitHub-Namen. +Das Projekt lebt von der Mitarbeit vieler Menschen, die Fragen beantworten, neue Versionen testen, Geräte einbinden, übersetzen und Code schreiben. +Unter [Mitmachen](/de/contribute) findest du, wo du einsteigen kannst. + +Du hast schon einiges beigetragen? [Schreib uns eine kurze Mail](mailto:info@evcc.io) mit deinem GitHub-Namen und wir stellen dir ein unbefristetes Unterstützertoken aus. ## Testtoken \{#trial\} diff --git a/src/content/docs/en/contribute.mdx b/src/content/docs/en/contribute.mdx new file mode 100644 index 000000000..34b6a6b4f --- /dev/null +++ b/src/content/docs/en/contribute.mdx @@ -0,0 +1,83 @@ +--- +title: "Contribute" +description: "Shows how you can help by answering questions, testing nightly and PR builds, supporting your own devices, translating, editing the docs or writing code." +--- + +evcc is built by the community. +Most ways to help don't need any code. + +## Start Small \{#start} + +Don't start with your favourite big feature, even though AI agents make that incredibly easy and tempting. +Read along in [discussions](https://github.com/evcc-io/evcc/discussions) and [issues](https://github.com/evcc-io/evcc/issues) first and get a feel for how the community works. +Your idea has probably come up before, so search for it and join the existing conversation. +Begin with something small and grow from there. +Bigger changes need agreement in an issue or discussion before moving on to implementation and a pull request. + +## Help Others \{#help} + +Many questions in the [discussions](https://github.com/evcc-io/evcc/discussions/categories/need-help) can be answered by someone who owns the same device or had the same problem. +Triage helps too: reproduce reported bugs, ask for missing logs and point to duplicates. +[Report a Problem](/en/report-a-problem) explains what a helpful issue contains. + +## Test New Versions \{#testing} + +The nightly build contains everything that has been merged since the last release. +All installation guides (e.g. [Linux](/en/installation/linux), [Docker](/en/installation/docker) or [Home Assistant](/en/installation/home-assistant)) explain how to switch to it. +Back up your installation before you switch. +New features often start as experimental and need to be enabled in **Configuration → Experimental**. + +For a pull request, maintainers can publish a test build with binaries and a Docker image `evcc/evcc:pr-`. +A short test report from someone with the matching hardware is often what gets a change merged. +If a pull request has no test build yet but you could test it, feel free to ask for one in the pull request. + +To try new versions of the iOS and Android app early, see the [beta section of the app](https://github.com/evcc-io/app#beta-testing). + +## Your Own Devices \{#devices} + +The best first contributions come from your own setup. +You own an inverter, home battery, vehicle or charger that maintainers can't test. +Confirm fixes or improve the instructions of a template. +Your device isn't supported yet? Set it up as a [user-defined device](/en/user-defined-devices) first and, once it works, turn it into a template for everyone. + +## Translate \{#translate} + +The interface is translated on [Weblate](https://hosted.weblate.org/engage/evcc/). +Add a new language or check and improve an existing one, no developer tools needed. + +## Improve the Docs \{#docs} + +Every page has an **Edit page** link at the bottom that takes you to its source on GitHub. +The documentation is written in English and German. +If you only speak one of them, mention it in your pull request and we'll help with the other. + +## Write Code \{#code} + +The [contribution guidelines](https://github.com/evcc-io/evcc/blob/master/CONTRIBUTING.md) cover the ground rules, the development setup and how to test locally. +General development topics are discussed on [Slack](https://evcc.io/slack). + +## Build Something Around evcc \{#build} + +Dashboards, displays, utilities or hardware gadgets that help other users are contributions too. +The [REST API](/integrations/rest-api) and [MQTT API](/en/integrations/mqtt-api) give you access to all data of your evcc instance. +Show your project in the discussions and add it to [More Awesome Projects](/en/smarthome/awesome). + +## Project Overview \{#projects} + +| Repository | What it is | Tech | +| --------------------------------------------------------------- | ---------------------------------------------- | --------------- | +| [evcc-io/evcc](https://github.com/evcc-io/evcc) | Core, web interface and device templates | Go, Vue | +| [evcc-io/app](https://github.com/evcc-io/app) | iOS and Android app | React Native | +| [evcc-io/optimizer](https://github.com/evcc-io/optimizer) | [Optimizer](/en/features/optimizer) service | Python | +| [evcc-io/docs](https://github.com/evcc-io/docs) | This documentation | Astro, Markdown | +| [evcc-io/images](https://github.com/evcc-io/images) | Linux images for Raspberry Pi and other boards | Armbian | +| [evcc-io/hassio-addon](https://github.com/evcc-io/hassio-addon) | Home Assistant app | Docker | +| [evcc-io/evcc.io](https://github.com/evcc-io/evcc.io) | Website | Hugo | + +[Report a Problem](/en/report-a-problem#where) lists which repository a problem belongs to. + +## Contributor Tokens \{#token} + +The project lives on the contributions of many people, with code, templates, docs, translations, answers in the discussions or detailed test reports. + +Already contributed a fair bit? [Send us a short email](mailto:info@evcc.io) with your GitHub username and we'll issue you an unlimited sponsor token. diff --git a/src/content/docs/en/index.mdx b/src/content/docs/en/index.mdx index 586ad20c7..4ec49c2cd 100644 --- a/src/content/docs/en/index.mdx +++ b/src/content/docs/en/index.mdx @@ -122,7 +122,6 @@ evcc comes without any kind of guarantee, and you use the software at your own r ## Meet the Community - Support, configurations, questions about devices, and general discussion can be found in our [Community Support Forum](https://github.com/evcc-io/evcc/discussions). -- [Report a Problem](/en/report-a-problem) explains how to get help quickly and what a good report contains. -- We also have a [Slack](https://evcc.io/slack) for development discussion. +- Want to get involved? [Contribute](/en/contribute) shows how you can help, with or without code. Looking for more? Check out [Talks, Videos & Blogs](/en/media). diff --git a/src/content/docs/en/sponsorship.mdx b/src/content/docs/en/sponsorship.mdx index 49b934d43..dc5703538 100644 --- a/src/content/docs/en/sponsorship.mdx +++ b/src/content/docs/en/sponsorship.mdx @@ -58,14 +58,10 @@ As a small thank you, you'll receive **digital supporter confetti 🎉** inside ## Contributor Tokens -You want to contribute to the development? -We'd love that! -Look at the [list of open issues](https://github.com/evcc-io/evcc/issues) or [contact us](mailto:info@evcc.io) with concrete ideas on how you'd like to contribute. -Significant contributions to the [documentation](https://github.com/evcc-io/docs) or [translations](https://github.com/evcc-io/evcc/blob/master/CONTRIBUTING.md#adding-or-modifying-translations) also qualify for a contributor token. -[Here](https://github.com/evcc-io/evcc/blob/master/CONTRIBUTING.md) you'll find more information on how to get started. - -As a contributor, we'll issue you an unlimited contributor token. -[Send us a short email](mailto:info@evcc.io) with your GitHub username. +The project lives on the contributions of many people who answer questions, test new versions, add devices, translate and write code. +[Contribute](/en/contribute) shows where you can get started. + +Already contributed a fair bit? [Send us a short email](mailto:info@evcc.io) with your GitHub username and we'll issue you an unlimited sponsor token. ## Trial Token \{#trial\}