Этот репозиторий является основным источником документации для разработчиков Flatpak. Его можно прочитать на docs.flatpak.org.
Некоторая документация также доступна на вики Flatpak и на страницах руководства flatpak и flatpak-builder .
Документы написаны на reStructuredText, и вклад приветствуется!
Создайте виртуальную среду Python:
python3 -m venv .venv && источник .venv/bin/activate
Затем установите зависимости с помощью pip :
pip install -r требования.txt
После установки вы можете собрать документацию:
сделать -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 больше не существует), запустив:
сделать -C docs update-po
Разработчики настольных приложений — основная аудитория документации Flatpak, особенно авторы существующих приложений, в том числе для платформ, отличных от Linux.
Документы должны, где это возможно, отражать популярную практику среди этой аудитории и не предполагать, что приложения исходят из настольной среды Linux. На практике это означает, что нам следует ожидать:
.desktop , AppStream и D-Bus.Помимо этих базовых настроек по умолчанию, особое внимание следует уделить популярным кроссплатформенным технологиям, таким как Electron и Qt.
Рекомендации для тех, кто хочет внести свой вклад в документацию:
