Proposed changed to documentation

[Michael Hall]

Hello everyone,

Recently I've been looking at the developer experience around Flatpak, 
and especially the documentation available, from the perspective of an 
app developer looking to make his first Flatpak. I found that, while 
there is a lot of documentation written, it's not easy to follow and 
often doesn't give enough information for me to fully understand how 
Flatpak works.

So, to try and improve this, I've put together a sitemap (link below) 
for documentation that I think will lead to a better developer 
experience, and ultimately more Flatpaks. This is a high-level view of 
the site structure and navigation, I will fill each section in with 
more specific information needs. But first I wanted to make sure that 
this sitemap has approval from all the necessary people, and that pull 
requests to implement it would be accepted. If I can get that buy-in, I 
will finish fleshing out the rest of the details and then work on 
finding people who can help write the missing pieces.

Proposed sitemap: 
https://github.com/flatpak/flatpak/wiki/Documentation-Sitemap-proposal

I wil be able to commit some of my work time at Endless to this work, 
but I don't have the knowledge or skills to write the documentation 
itself. I can contribute to planning, editing, and organizing the pull 
requests though. Nuritzi and I will see if GNOME can allocate funds to 
contract a technical writer, and if not I'll work on recruiting 
volunteers to get it done.
--
Michael Hall
mhall119 at gmail.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.freedesktop.org/archives/flatpak/attachments/20171207/5db247b1/attachment.html>