documents flatpak

flatpak-docs

Ce référentiel est la principale source de documentation du développeur pour Flatpak. Il peut être lu sur docs.flatpak.org.

Une certaine documentation est également disponible sur le wiki Flatpak et dans le cadre des pages de manuel flatpak et flatpak-builder .

Les documents sont rédigés en reStructuredText et les contributions sont les bienvenues !

Développement de configuration

Créez un environnement virtuel Python :

 python3 -m venv .venv && source .venv/bin/activate

Installez ensuite les dépendances avec pip :

 pip install -r exigences.txt

Construire la documentation

Après l'installation, vous pouvez créer la documentation :

 make -C documents html

Exécutez les tests :

 make -C docs vérification des liens

Vous pouvez exécuter un serveur HTTP et suivre le lien imprimé (localhost:8000) pour afficher la documentation dans votre navigateur :

 python3 -m http.server -d docs/_build/html

Créer des traductions

Par défaut, le document en cours de construction est en anglais. Si vous souhaitez créer des documents dans d'autres langues, comme le chinois, vous pouvez utiliser la commande suivante :

 make -C docs html SPHINXOPTS='-D langue=zh_CN'

Traduire la documentation

Vous pouvez ouvrir une pull request en ajoutant une nouvelle langue.

Les responsables peuvent générer les fichiers modèles ( .pot ), mettre à jour les fichiers de traduction ( .po ) et supprimer les fichiers de traduction obsolètes (c'est-à-dire qu'un fichier .pot correspondant n'existe plus) en exécutant :

 make -C docs update-po

Public

Les développeurs d'applications de bureau constituent le public principal des documents Flatpak, en particulier les auteurs d'applications existantes, y compris celles provenant de plates-formes non Linux.

Les documents doivent refléter autant que possible les pratiques populaires parmi ce public et ne pas supposer que les applications proviennent de l'espace de bureau Linux. Concrètement, cela signifie que nous devons nous attendre à :

• Git pour le contrôle de version
• GitHub pour l'hébergement
• Runtimes Freedesktop
• Aucune connaissance préalable des conventions de bureau Linux, telles que les fichiers .desktop , AppStream et D-Bus

En dehors de ces valeurs par défaut de base, une attention particulière doit être accordée aux technologies multiplateformes populaires telles qu'Electron et Qt.

Lignes directrices

Lignes directrices pour ceux qui souhaitent contribuer aux documents :

• Expliquer les concepts de base de Flatpak
• Concentrez-vous sur les flux de travail standard des développeurs d'applications
• Utilisez la documentation pour expliquer les avantages de Flatpak et pourquoi un développeur pourrait l'utiliser
• Ne couvrez que ce qui est essentiel pour les développeurs d'applications - n'incluez pas de détails sur les composants internes de Flatpak, sauf si cela est absolument nécessaire.
• Offrez une expérience aux développeurs aussi fluide et sans friction que possible
• Aidez à prévenir les difficultés en anticipant les problèmes potentiels que les développeurs pourraient rencontrer et en les éloignant.