Improving Flatpak documentation

[Allan Day]

On Tue, Jan 10, 2017 at 12:01 PM, Alexander Larsson <alexl at redhat.com>
wrote:
...

>
> If you are interested I can try to see how it works. I also like the
> ReadTheDocs option, so whatever you think is best.
>
>
> I'd be happy with either solution also. It's really up to the people
> writing the docs and maintaining the website - meaning Alex and Jakub.
> Jakub's expressed a preference for ReadTheDocs, since it means less
> maintenance on the website.
>
> I don't have any real opinion here. ReadTheDocs seems nice, and if Jakub
> prefers that I think we should go with that. Also, it means we're using the
> same system as OSTree which makes sense.
>

That works for me and I'd be happy to port our docs over this week. That
should clear the way for the website updates [1] that Jakub and I have been
working on this week.

For the record, OSTree uses markdown for its docs (meaning that search
doesn't work on ReadTheDocs), which are kept within the OSTree repo.

I'm assuming that we'll use reStructuredText, kept in a separate repo in
our Github - so a little different from OSTree.

Allan

[1] https://github.com/flatpak/flatpak.github.io/tree/newstructure2017
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.freedesktop.org/archives/flatpak/attachments/20170110/3a19d211/attachment.html>