documentos planos

documentos-planpak

Este repositorio es la principal fuente de documentación para desarrolladores de Flatpak. Se puede leer en docs.flatpak.org.

Parte de la documentación también está disponible en la wiki de Flatpak y como parte de las páginas de manual flatpak y flatpak-builder .

Los documentos están escritos en reStructuredText y las contribuciones son bienvenidas.

Desarrollo de configuración

Cree un entorno virtual de Python:

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

Luego instale las dependencias con pip :

 instalación de pip -r requisitos.txt

Construya la documentación

Después de la configuración, puede crear la documentación:

 hacer -C documentos html

Ejecute las pruebas:

 hacer -C verificación de enlace de documentos

Puede ejecutar un servidor HTTP y seguir el enlace impreso (localhost:8000) para ver la documentación en su navegador:

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

Construir traducciones

De forma predeterminada, el documento que se está creando está en inglés. Si desea crear documentos en otros idiomas, como el chino, puede utilizar el siguiente comando:

 hacer -C docs html SPHINXOPTS='-D idioma=zh_CN'

Traducir la documentación

Puedes abrir una solicitud de extracción agregando un nuevo idioma.

Los mantenedores pueden generar los archivos de plantilla ( .pot ), actualizar los archivos de traducción ( .po ) y eliminar archivos de traducción obsoletos (es decir, ya no existe un archivo .pot coincidente) ejecutando:

 hacer -C docs actualizar-po

Audiencia

Los desarrolladores de aplicaciones de escritorio son el público principal de los documentos Flatpak, en particular los autores de aplicaciones existentes, incluidas aquellas de plataformas que no son Linux.

Los documentos deben reflejar las prácticas populares entre esta audiencia siempre que sea posible y no asumir que las aplicaciones provienen del espacio de escritorio de Linux. En términos prácticos, esto significa que deberíamos esperar:

• Git para control de versiones
• GitHub para alojamiento
• Tiempos de ejecución de escritorio gratuitos
• Sin conocimientos previos de las convenciones de escritorio de Linux, como archivos .desktop , AppStream y D-Bus.

Fuera de estos valores predeterminados básicos, se debe prestar especial atención a las tecnologías multiplataforma populares como Electron y Qt.

Pautas

Pautas para aquellos que quieran contribuir a los documentos:

• Explicar conceptos básicos de Flatpak.
• Centrarse en los flujos de trabajo de desarrollador de aplicaciones estándar
• Utilice los documentos para explicar los beneficios de Flatpak y por qué un desarrollador podría usarlo
• Cubre solo lo que es esencial para los desarrolladores de aplicaciones; no incluyas detalles de los componentes internos de Flatpak a menos que sea absolutamente necesario.
• Proporcione una experiencia de desarrollador lo más fluida y sin fricciones posible
• Ayude a prevenir dificultades anticipando los problemas potenciales que los desarrolladores podrían enfrentar y manteniéndolos alejados de ellos.