From: Thomas Huth <thuth@redhat.com>
To: "Daniel P. Berrangé" <berrange@redhat.com>, qemu-devel@nongnu.org
Cc: Paolo Bonzini <pbonzini@redhat.com>, Stefan Weil <sw@weilnetz.de>,
Jeff Cody <codyprime@gmail.com>
Subject: Re: [Qemu-devel] [qemu-web PATCH] Import historical documentation
Date: Tue, 4 Dec 2018 11:56:04 +0100 [thread overview]
Message-ID: <08d36eda-e8e7-4ece-edc5-ef436d25e6b7@redhat.com> (raw)
In-Reply-To: <20181203164105.29858-1-berrange@redhat.com>
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é <berrange@redhat.com>
> ---
>
> 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
this...
Thomas
next prev parent reply other threads:[~2018-12-04 10:56 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-12-03 16:41 [Qemu-devel] [qemu-web PATCH] Import historical documentation Daniel P. Berrangé
2018-12-03 19:14 ` Marc-André Lureau
2018-12-04 10:19 ` Daniel P. Berrangé
2018-12-04 10:56 ` Thomas Huth [this message]
2018-12-06 20:01 ` Paolo Bonzini
2018-12-07 9:44 ` Daniel P. Berrangé
2018-12-07 15:59 ` Michael Roth
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=08d36eda-e8e7-4ece-edc5-ef436d25e6b7@redhat.com \
--to=thuth@redhat.com \
--cc=berrange@redhat.com \
--cc=codyprime@gmail.com \
--cc=pbonzini@redhat.com \
--cc=qemu-devel@nongnu.org \
--cc=sw@weilnetz.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).