Este repositório é a principal fonte de documentação do desenvolvedor para Flatpak. Ele pode ser lido em docs.flatpak.org.
Alguma documentação também está disponível no wiki do Flatpak e como parte das páginas de manual flatpak e flatpak-builder .
Os documentos são escritos em reStructuredText e contribuições são bem-vindas!
Crie um ambiente virtual Python:
python3 -m venv .venv && source .venv/bin/ativar
Em seguida, instale as dependências com pip :
pip instalar -r requisitos.txt
Após a configuração, você pode criar a documentação:
faça -C documentos html
Execute os testes:
make -C docs linkcheck
Você pode executar um servidor HTTP e seguir o link impresso (localhost:8000) para visualizar a documentação em seu navegador:
python3 -m http.server -d docs/_build/html
Por padrão, o documento que está sendo construído está em inglês. Se quiser criar documentos em outros idiomas, como chinês, você pode usar o seguinte comando:
make -C docs html SPHINXOPTS='-D idioma=zh_CN'
Você pode abrir uma solicitação pull adicionando um novo idioma.
Os mantenedores podem gerar os arquivos de modelo ( .pot ), atualizar os arquivos de tradução ( .po ) e remover arquivos de tradução obsoletos (ou seja, um arquivo .pot correspondente não existe mais) executando:
make -C documentos update-po
Os desenvolvedores de aplicativos de desktop são o público principal dos documentos Flatpak, especialmente os autores de aplicativos existentes, incluindo aqueles de plataformas não-Linux.
Os documentos devem refletir a prática popular entre esse público sempre que possível e não presumir que os aplicativos vêm do espaço de desktop Linux. Em termos práticos, isto significa que devemos esperar:
Git para controle de versão
GitHub para hospedagem
Tempos de execução do Freedesktop
Nenhum conhecimento prévio de convenções de desktop Linux, como arquivos .desktop , AppStream e D-Bus
Fora desses padrões básicos, atenção especial deve ser dada às tecnologias populares de plataforma cruzada, como Electron e Qt.
Diretrizes para quem deseja contribuir com a documentação:
Explique os conceitos básicos do Flatpak
Concentre-se nos fluxos de trabalho padrão do desenvolvedor de aplicativos
Use a documentação para explicar os benefícios do Flatpak e por que um desenvolvedor pode usá-lo
Cubra apenas o que é essencial para desenvolvedores de aplicativos - não inclua detalhes internos do Flatpak, a menos que seja absolutamente necessário
Forneça uma experiência de desenvolvedor tão tranquila e simples quanto possível
Ajude a evitar dificuldades, antecipando possíveis problemas que os desenvolvedores possam encontrar e orientando-os para longe deles
