フラットパックのドキュメント

フラットパックドキュメント

このリポジトリは、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 docs html

テストを実行します。

 make -C docs linkcheck

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 docs update-po

観客

Flatpak ドキュメントの主な対象読者はデスクトップ アプリケーション開発者で、特に Linux 以外のプラットフォームを含む既存のアプリケーションの作成者です。

ドキュメントは、可能な限りこの読者の間で一般的な慣行を反映する必要があり、アプリケーションが Linux デスクトップ領域からのものであることを前提とすべきではありません。実際的には、これは次のことを期待する必要があることを意味します。

• バージョン管理のための Git
• ホスティング用の GitHub
• フリーデスクトップ ランタイム
• .desktopファイル、AppStream、D-Bus などの Linux デスクトップ規約に関する事前知識なし

これらの基本的なデフォルト以外に、Electron や Qt などの一般的なクロスプラットフォーム テクノロジには特別な注意を払う必要があります。

ガイドライン

ドキュメントに貢献したい人のためのガイドライン:

• Flatpak の基本的な概念を説明する
• 標準的なアプリケーション開発者のワークフローに重点を置く
• ドキュメントを使用して、Flatpak の利点と開発者がそれを使用する理由を説明します。
• アプリケーション開発者にとって重要なことのみを取り上げます。絶対に必要な場合を除き、Flatpak の内部の詳細は含めないでください。
• 可能な限りスムーズで摩擦のない開発者エクスペリエンスを提供する
• 開発者が遭遇する可能性のある潜在的な問題を予測し、問題を回避することで問題を回避します。