Improving Flatpak documentation

[Jorge García]

Hi,

Below you will find a quick list of places where you can actually find
useful flatpak documentation. As you will see, the docs are in many
different places (main site, flatpak's github wikis, some personal blogs,
...). Some information is duplicated and some is also outdated.

I propose to improve the main flatpak website adding a  documentation
section, something like Angular's website
<https://angular.io/docs/ts/latest/>, or Ionic Framework
<https://ionicframework.com/docs/v2/> or create a manual at readthedocs
like OStree. <https://ostree.readthedocs.io/en/latest/> (some of the
information in flatpak's wiki is in Markdown already so most of the effort
won't be wasted)

I can help setting up the things (readthedocs, jekyll, ...) and organizing
a little bit the docs, but I would like to have some help (I'm not a native
English speaker)

What do you think?

Best regards,
Jorge



Current docs:

*Flatpak website*
 - Front page http://flatpak.org/index.html
   - Intro to flatpak
   - Install and Run a Flatpak
   - Create an App with Flatpak
   - Get involved

 - Getting flatpak http://flatpak.org/getting.html
 - Apps  http://flatpak.org/apps.html
 - Runtimes http://flatpak.org/runtimes.html
 - FAQ http://flatpak.org/faq.html
 - Getting Started with Flatpak http://flatpak.org/developer.html
   - Key Concepts
   - Technologies
   - The flatpak Command
   - Anatomy of a Flatpak App
   - Building Simple Apps
   - Building More Complex Apps With flatpak-builder
   - Working with the Sandbox
   - Distributing Applications
 - Bundling a Java Application with Flatpak
http://flatpak.org/bundling-a-java-app.html
 - xdg-desktop-portal d-bus interfaces documentation
http://flatpak.org/xdg-desktop-portal/portal-docs.html


Flatpak Github's repo: https://github.com/flatpak/flatpak

   - Wiki https://github.com/flatpak/flatpak/wiki

    Intro

    Information for Developers
        Example Apps and Runtimes
        Tips & Tricks

    Technical Details

        Application Filesystem
        Portals
        Sandbox
        Application Metadata

    Flathub

        Flathub
        Goals
        Workflows
        Relevant Art

    Miscellaneous

        Flatpak's History
        Flatpak in the Press

   - Release notes https://github.com/flatpak/flatpak/releases

* xdg-desktop-portal's github repo:
https://github.com/flatpak/xdg-desktop-portal

* Man pages

* Alex Larsson blog
- Multi-part tutorial in how to create xdg-app applications.
https://blogs.gnome.org/alexl/2016/02/19/building-an-xdg-app-part-1/

* Richard Hugges blog https://blogs.gnome.org/hughsie/
- Gnome Software integration with flatpak
- Add 3r party repos:
https://blogs.gnome.org/hughsie/2016/04/27/3rd-party-fedora-repositories-and-appstream/

* Mathias Classen's blog:
- Portals: Using GTK+ in a Flatpak
https://blogs.gnome.org/mclasen/2016/07/08/portals-using-gtk-in-a-flatpak/

* KDE's Guidelines and HOWTOs/Flatpak (
https://community.kde.org/Guidelines_and_HOWTOs/Flatpak)
    1 KDE Runtime
    2 Compile your application
    3 Contribute!
    4 Flatpak portals
        4.1 KDE implementation of portals
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.freedesktop.org/archives/flatpak/attachments/20161123/cef56a4c/attachment.html>