[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [Qemu-devel] [qemu-web PATCH] Import historical documentation

From: Thomas Huth
Subject: Re: [Qemu-devel] [qemu-web PATCH] Import historical documentation
Date: Tue, 4 Dec 2018 11:56:04 +0100
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.9.1

On 2018-12-03 17:41, Daniel P. Berrangé wrote:
> The files included are taken from formal builds of previous versions
> of QEMU, going back to 2.0.0
>   - qemu-doc.html
>   - qemu-qmp-ref.html
>   - qemu-ga-ref.html
> To import them all content outside of <body></body> is stripped and
> replaced by a trivial jekyll header. This causes the rendered docs
> to get consistent styling and navbar heading.
> Signed-off-by: Daniel P. Berrangé <address@hidden>
> ---
> This patch shows what it would be like if we just copied the
> pre-rendered QEMU docs into qemu-web for each major release....
> ...it would be large. 2.0.0 was only 300 KB in size, but latest
> 3.0.0 release has 1.3 MB of docs. So we'd be adding about 4 MB
> of docs to qemu-web each year if we committed them.
> This feels undesirable as a strategy.

I also dislike the idea to store data in the git repo that is generated
automatically from other sources (qemu-doc.texi and friends in this case).

> At least in terms of the end result for users, I think it is
> positive.

Agreed, for the users it might be helpful to have access to all
different versions of the documenation.

> Other ideas
>  1. Upload built docs to a lookaside directory on the download
>     site when making a release, then have a jekyll plugin to
>     pull them in. Extra work for the person making releases
>     principally.
>  2. Have a jekyll plugin that uses docker env to build each
>     release docs from pristine tarballs. Would need caching
>     to avoid burning CPU cycles in each web update. Reliably
>     building older QEMU versions gets increasingly troublesome

We'd also need to discuss how new docs get added after a release
anyway... automatically? Manually? In the latter case, who does that job?

I think it would be best if we find a way to automate this process, e.g.
when a new release is tagged, a script generates the docs and puts them
somewhere on the web server, into the right new folder based on the name
of the tag. However, I don't know the qemu server well enough to know
whether that's possible or not ... maybe Jeff or Paolo can comment on


reply via email to

[Prev in Thread] Current Thread [Next in Thread]