Re: [qemu-web PATCH] Update the documentation links to point to our generated docs

[Peter Maydell]

On Mon, 3 Feb 2020 at 13:19, Thomas Huth <address@hidden> wrote:
>
> We are now providing the generated QEMU documentation files directly
> on our www.qemu.org webserver, so we should link to these files now.
>
> Signed-off-by: Thomas Huth <address@hidden>
> ---
>  _includes/footer.html |  2 +-
>  documentation.md      | 14 +++++++++++---
>  2 files changed, 12 insertions(+), 4 deletions(-)
>
> diff --git a/_includes/footer.html b/_includes/footer.html
> index 1669ef7..e67ffd7 100644
> --- a/_includes/footer.html
> +++ b/_includes/footer.html
> @@ -14,7 +14,7 @@
>                 </ul>
>                 <ul class="style">
>                         <li><a href="/documentation">Documentation</a></li>
> -                       <li><a 
> href="https://qemu.weilnetz.de/qemu-doc.html";>Manual</a></li>
> +                       <li><a 
> href="https://www.qemu.org/docs/master/qemu-doc.html";>User manual</a></li>

This is the old texinfo user manual, and it no longer contains
all the information it used to (as we have been moving parts of
it out to the rST manuals). It's going to go away entirely
at some point. The equivalent "here's the top level of the docs"
in the new rST world is https://www.qemu.org/docs/master/,
which has links to the various rST manuals (and also the
qemu-doc.html).

>                         <li><a 
> href="https://wiki.qemu.org/Category:Developer_documentation";>Developer 
> docs</a></li>
>                         <li><a href="https://wiki.qemu.org/";>Wiki</a></li>
>                 </ul>
> diff --git a/documentation.md b/documentation.md
> index f4ef9f4..e96c39a 100644
> --- a/documentation.md
> +++ b/documentation.md
> @@ -3,9 +3,17 @@ title: QEMU documentation
>  permalink: /documentation/
>  ---
>
> -The [QEMU user manual](https://qemu.weilnetz.de/qemu-doc.html) can be read 
> online, courtesy of Stefan Weil.
> -More documentation is found in the <a 
> href="https://git.qemu.org/?p=qemu.git;a=tree;f=docs;hb=master";>`docs`</a>
> -directory of the QEMU git tree.
> +The [QEMU user manual](https://www.qemu.org/docs/master/qemu-doc.html)
> +is the first place to go in case you have questions about using QEMU.
> +
> +A lot of additional documentation can be found in our
> +[documentation section](https://www.qemu.org/docs/master/)
> +which is generated automatically from the QEMU git source tree.

Similarly here we shouldn't directly link to qemu-doc.html.

> +
> +Some text files have not been converted to the new format yet, though.
> +These documentation files can be browsed via the
> +[git web interface](https://git.qemu.org/?p=qemu.git;a=tree;f=docs;hb=master)
> +instead.
>
>  The [QEMU wiki](https://wiki.qemu.org) contains more
>  [user documentation](https://wiki.qemu.org/Category:User_documentation) and
> --
> 2.18.1

thanks
-- PMM