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.

Dokumentationsrichtlinien

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.

Lokales Erstellen der Dokumentation

Die Dokumentation kann auch lokal bearbeitet und erstellt werden, die Python-Anforderungen befinden sich in der Abhängigkeitsgruppe docs in pyproject.toml. Die Erstellung kann mit ci/run-docs durchgeführt werden.

Hinweis

Zum Erstellen der Dokumentation muss außerdem graphviz installiert sein.

Übersetzen der Dokumentation

Sie können die Dokumentation übersetzen.

Dokumentieren von Berechtigungen, Prüfungen, Erweiterungen und automatischen Vorschlägen

Mehrere Abschnitte der Dokumentation verwenden aus dem Code generierte Vorlagen. Die folgenden Verwaltungsbefehle sind verfügbar:

Alle diese Befehle geben reStructuredText aus, der als Vorlage für die Dokumentation dient. Änderungen an der Dokumentation lassen sich am einfachsten mithilfe von Visual diff in Ihrem Editor vornehmen.