Dieses Repository ist die Hauptquelle der Entwicklerdokumentation für Flatpak. Es kann unter docs.flatpak.org gelesen werden.
Einige Dokumentationen sind auch im Flatpak-Wiki und als Teil der Manpages flatpak und flatpak-builder verfügbar.
Die Dokumente sind in reStructuredText verfasst und Beiträge sind willkommen!
Erstellen Sie eine virtuelle Python-Umgebung:
python3 -m venv .venv && source .venv/bin/activate
Dann installieren Sie die Abhängigkeiten mit pip :
pip install -r Anforderungen.txt
Nach der Einrichtung können Sie die Dokumentation erstellen:
make -C docs html
Führen Sie die Tests durch:
Machen Sie -C docs Linkcheck
Sie können einen HTTP-Server ausführen und dem gedruckten Link (localhost:8000) folgen, um die Dokumentation in Ihrem Browser anzuzeigen:
python3 -m http.server -d docs/_build/html
Standardmäßig ist das zu erstellende Dokument auf Englisch. Wenn Sie Dokumente in anderen Sprachen, beispielsweise Chinesisch, erstellen möchten, können Sie den folgenden Befehl verwenden:
make -C docs html SPHINXOPTS='-D language=zh_CN'
Sie können eine Pull-Anfrage öffnen und eine neue Sprache hinzufügen.
Betreuer können die Vorlagendateien ( .pot ) generieren, die Übersetzungsdateien ( .po ) aktualisieren und veraltete Übersetzungsdateien entfernen (d. h. eine passende .pot Datei ist nicht mehr vorhanden), indem sie Folgendes ausführen:
make -C docs update-po
Entwickler von Desktop-Anwendungen sind die Hauptzielgruppe für die Flatpak-Dokumente, insbesondere die Autoren bestehender Anwendungen, einschließlich solcher von Nicht-Linux-Plattformen.
Die Dokumente sollten nach Möglichkeit die gängige Praxis dieser Zielgruppe widerspiegeln und nicht davon ausgehen, dass Anwendungen aus dem Linux-Desktopbereich stammen. In der Praxis bedeutet dies, dass wir Folgendes erwarten sollten:
Git zur Versionskontrolle
GitHub zum Hosten
Freedesktop-Laufzeiten
Keine Vorkenntnisse über Linux-Desktop-Konventionen wie .desktop Dateien, AppStream und D-Bus
Außerhalb dieser Grundvorgaben sollte besonderes Augenmerk auf beliebte plattformübergreifende Technologien wie Electron und Qt gelegt werden.
Richtlinien für diejenigen, die zu den Dokumenten beitragen möchten:
Erklären Sie grundlegende Flatpak-Konzepte
Konzentrieren Sie sich auf Standard-Workflows für Anwendungsentwickler
Erklären Sie anhand der Dokumente die Vorteile von Flatpak und warum ein Entwickler es verwenden könnte
Decken Sie nur das Wesentliche für Anwendungsentwickler ab – geben Sie keine Details zu Flatpak-Interna an, es sei denn, dies ist unbedingt erforderlich
Bieten Sie ein möglichst reibungsloses und reibungsloses Entwicklererlebnis
Helfen Sie dabei, Schwierigkeiten vorzubeugen, indem Sie potenzielle Probleme antizipieren, auf die Entwickler stoßen könnten, und sie von ihnen fernhalten
