<div dir="ltr"><div class="gmail_extra"><div class="gmail_quote">Hey Jorge!<br></div><div class="gmail_quote"><br>Jorge García <span dir="ltr"><<a href="mailto:jgarciao@gmail.com" target="_blank">jgarciao@gmail.com</a>></span> wrote:<br>...<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div>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, ...). </div></div></blockquote><div><br><div>I don't think it's necessarily a bad thing to have docs in
different places, depending on the audience. For example, the split
between the docs on the website and the wiki makes sense to me, since
the stuff on the wiki isn't intended for users or for normal application
authors. Likewise, most of the pages on the website, like the ones that
are aimed at end users and testers, seem fine.<br><br></div>I also
don't think it's necessarily an issue to have material initially appear
in personal blogs and then get moved over to other more permanent
locations. This is what happened with the developer page [1] on the
website - this was basically a rewrite of Alex's blog posts. However,
those blog posts should maybe have a warning added to them, to indicate
that they are outdated and that people should use the official
documentation instead.<br> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div>Some information is duplicated and some is also outdated.<br></div></div></blockquote><div><br>The documentation being outdated can only be fixed
by updating the documentation. :) There's a list of documentation issues
filed against the website that anyone can tackle today [2]. I am
conscious that we are somewhat behind in this area and that the website
needs updates in a few areas. It's been on my mind for a while that we
should collectively spend a bit of time on this.<br> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div>I propose to improve the main flatpak website adding a documentation section, something like <a href="https://angular.io/docs/ts/latest/" target="_blank">Angular's website</a>, or <a href="https://ionicframework.com/docs/v2/" target="_blank">Ionic Framework</a> or create a manual at readthedocs like <a href="https://ostree.readthedocs.io/en/latest/" target="_blank">OStree.</a> (some of the information in flatpak's wiki is in Markdown already so most of the effort won't be wasted)<br><br></div><div>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)<br><br></div><div>What do you think?</div></div></blockquote><div><br></div><div>As time goes on it is likely that we will need a more advanced method for hosting and organisatiing the developer docs [1]. Are we at the point where we need to do that? I'm not sure.<br><br></div><div>Since there will likely need to be documentation for Flathub, it would be good to include that in our plans. Perhaps we want a separate docs site that covers both Flatpak and Flathub (like <a href="http://docs.flatpak.org">docs.flatpak.org</a>)?<br><br></div><div>Thanks for bringing this up - it's definitely a conversation we needed to have at some point.<br></div><div><br></div><div>Allan<br><br>[1] <a href="http://flatpak.org/developer.html">http://flatpak.org/developer.html</a><br>[2] <a href="https://github.com/flatpak/flatpak.github.io/issues">https://github.com/flatpak/flatpak.github.io/issues</a><br></div></div></div></div>