Zur Weblate-Dokumentation beitragen

Sie sind herzlich eingeladen, die Dokumentationsseite Ihrer Wahl zu verbessern. Klicken Sie dazu einfach auf die Schaltfläche Edit this page in der oberen rechten Ecke der Seite.

Documentation guidelines

Bitte beachten Sie diese Richtlinien beim Schreiben:

  1. Entfernen Sie keinen gültigen Teil der Dokumentation.

  2. Verwenden Sie eine klare und leicht verständliche Sprache. Sie schreiben eine technische Dokumentation, kein Gedicht. Nicht alle Leser von Dokumentationen sind Muttersprachler, seien Sie rücksichtsvoll.

  3. Scheuen Sie sich nicht zu fragen, wenn Sie sich nicht sicher sind. Wenn Sie während dem Bearbeiten eine Frage zu einer Funktion haben, ändern Sie die Dokumentation nicht, bevor Sie die Antwort haben. Das bedeutet: Entweder Sie ändern oder Sie fragen. Tun Sie nicht beides gleichzeitig.

  4. Überprüfen Sie Ihre Änderungen, indem Sie die beschriebenen Aktionen durchführen und dabei die Dokumentation beachten.

  5. Senden Sie Pull Requests mit Änderungen in kleinen Teilen, damit sie leichter und schneller überprüft und zusammengeführt werden können.

  6. Wenn Sie einen großen Artikel umschreiben und seine Struktur ändern wollen, sollten Sie dies in zwei Schritten tun:

    1. Umschreiben

    2. Sobald die Neufassung geprüft, ausgefeilt und zusammengeführt wurde, ändern Sie die Struktur der Absätze in einem weiteren Pull Request.

Building the documentation locally

Documentation can be also edited and built locally, the Python requirements are in the docs dependency group in pyproject.toml. The build can be performed using ci/run-docs.

Hinweis

You will also need graphviz installed to build the documentation.

Translating the documentation

Sie können die Dokumentation übersetzen.

Documenting permissions, checks, add-ons and automatic suggestions

Several documentation sections use templates generated from the code. The following management commands are available:

All these commands output reStructuredText which is used as a template for the documentation. The easiest way to apply changes to the documentation is using visual diff in your editor.