Flatpak 文档

flatpak-文档

该存储库是 Flatpak 开发人员文档的主要来源。可以在 docs.flatpak.org 上阅读。

一些文档也可以在 Flatpak wiki 上找到，并作为flatpak和flatpak-builder手册页的一部分。

这些文档是用 reStructuredText 编写的，欢迎贡献！

设置开发

创建Python虚拟环境：

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

然后使用pip安装依赖项：

 pip install -r 要求.txt

构建文档

设置完成后，您可以构建文档：

 make -C 文档 html

运行测试：

 make -C 文档链接检查

您可以运行 HTTP 服务器并按照打印的链接 (localhost:8000) 在浏览器中查看文档：

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

构建翻译

默认情况下，正在构建的文档是英文的。如果你想构建其他语言的文档，比如中文，可以使用以下命令：

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

翻译文档

您可以打开添加新语言的拉取请求。

维护者可以通过运行以下命令来生成模板文件 ( .pot )、更新翻译文件 ( .po ) 并删除过时的翻译文件（即匹配的.pot文件不再存在）：

 make -C 文档更新-po

观众

桌面应用程序开发人员是 Flatpak 文档的主要受众，特别是现有应用程序（包括来自非 Linux 平台的应用程序）的作者。

这些文档应尽可能反映受众中的流行实践，而不是假设应用程序来自 Linux 桌面空间。实际上，这意味着我们应该期望：

• Git 用于版本控制
• 用于托管的 GitHub
• 免费桌面运行时
• 事先不了解 Linux 桌面约定，例如.desktop文件、AppStream 和 D-Bus

除了这些基本默认值之外，还应特别注意流行的跨平台技术，例如 Electron 和 Qt。

指南

对于那些想要为文档做出贡献的人的指南：

• 解释基本的 Flatpak 概念
• 专注于标准应用程序开发人员工作流程
• 使用文档解释 Flatpak 的优点以及开发人员可能使用它的原因
• 仅涵盖应用程序开发人员必需的内容 - 除非绝对必要，否则不要包含 Flatpak 内部的详细信息
• 提供尽可能流畅、无摩擦的开发人员体验
• 通过预测开发人员可能遇到的潜在问题并引导他们避开这些问题，帮助防止困难