[v2] docs: simplify each section title

[PATCH v2] docs: simplify each section title

Posted by marcandre.lureau@redhat.com 3 years, 1 month ago

From: Marc-André Lureau <marcandre.lureau@redhat.com>

Now that we merged into one doc, it makes the nav looks nicer.

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
---
v2:
 - Developers -> Developer Information (suggested by Peter)

 docs/devel/index.rst   | 4 ++--
 docs/interop/index.rst | 4 ++--
 docs/specs/index.rst   | 4 ++--
 docs/system/index.rst  | 4 ++--
 docs/tools/index.rst   | 4 ++--
 docs/user/index.rst    | 4 ++--
 6 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/docs/devel/index.rst b/docs/devel/index.rst
index 7c424ea6d7..60039faa68 100644
--- a/docs/devel/index.rst
+++ b/docs/devel/index.rst
@@ -1,8 +1,8 @@
 .. This is the top level page for the 'devel' manual.
 
 
-QEMU Developer's Guide
-======================
+Developer Information
+=====================
 
 This manual documents various parts of the internals of QEMU.
 You only need to read it if you are interested in reading or
diff --git a/docs/interop/index.rst b/docs/interop/index.rst
index 95d56495f6..219a5e5fc5 100644
--- a/docs/interop/index.rst
+++ b/docs/interop/index.rst
@@ -1,8 +1,8 @@
 .. This is the top level page for the 'interop' manual.
 
 
-QEMU System Emulation Management and Interoperability Guide
-===========================================================
+System Emulation Management and Interoperability
+================================================
 
 This manual contains documents and specifications that are useful
 for making QEMU interoperate with other software.
diff --git a/docs/specs/index.rst b/docs/specs/index.rst
index 1b0eb979d5..7b08314d33 100644
--- a/docs/specs/index.rst
+++ b/docs/specs/index.rst
@@ -1,8 +1,8 @@
 .. This is the top level page for the 'specs' manual
 
 
-QEMU System Emulation Guest Hardware Specifications
-===================================================
+System Emulation Guest Hardware Specifications
+==============================================
 
 
 Contents:
diff --git a/docs/system/index.rst b/docs/system/index.rst
index 6ad9c93806..02d0707181 100644
--- a/docs/system/index.rst
+++ b/docs/system/index.rst
@@ -1,8 +1,8 @@
 .. This is the top level page for the 'system' manual.
 
 
-QEMU System Emulation User's Guide
-==================================
+System Emulation
+================
 
 This manual is the overall guide for users using QEMU
 for full system emulation (as opposed to user-mode emulation).
diff --git a/docs/tools/index.rst b/docs/tools/index.rst
index 3a5829c17a..d923834a73 100644
--- a/docs/tools/index.rst
+++ b/docs/tools/index.rst
@@ -1,8 +1,8 @@
 .. This is the top level page for the 'tools' manual
 
 
-QEMU Tools Guide
-================
+Tools
+=====
 
 
 Contents:
diff --git a/docs/user/index.rst b/docs/user/index.rst
index e030dadf65..a5b47459ec 100644
--- a/docs/user/index.rst
+++ b/docs/user/index.rst
@@ -1,8 +1,8 @@
 .. This is the top level page for the 'user' manual.
 
 
-QEMU User Mode Emulation User's Guide
-=====================================
+User Mode Emulation
+===================
 
 This manual is the overall guide for users using QEMU
 for user-mode emulation.  In this mode, QEMU can launch
-- 
2.29.0

Re: [PATCH v2] docs: simplify each section title

Posted by Daniel P. Berrangé 3 years, 1 month ago

On Tue, Mar 23, 2021 at 11:47:04AM +0400, marcandre.lureau@redhat.com wrote:
> From: Marc-André Lureau <marcandre.lureau@redhat.com>
> 
> Now that we merged into one doc, it makes the nav looks nicer.
> 
> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
> ---
> v2:
>  - Developers -> Developer Information (suggested by Peter)
> 
>  docs/devel/index.rst   | 4 ++--
>  docs/interop/index.rst | 4 ++--
>  docs/specs/index.rst   | 4 ++--
>  docs/system/index.rst  | 4 ++--
>  docs/tools/index.rst   | 4 ++--
>  docs/user/index.rst    | 4 ++--
>  6 files changed, 12 insertions(+), 12 deletions(-)

Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>


Regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|

Re: [PATCH v2] docs: simplify each section title

Posted by John Snow 3 years, 1 month ago

On 3/23/21 3:47 AM, marcandre.lureau@redhat.com wrote:
> From: Marc-André Lureau <marcandre.lureau@redhat.com>
> 
> Now that we merged into one doc, it makes the nav looks nicer.
> 
> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>

Reviewed-by: John Snow <jsnow@redhat.com>

> ---
> v2:
>   - Developers -> Developer Information (suggested by Peter)
> 
>   docs/devel/index.rst   | 4 ++--
>   docs/interop/index.rst | 4 ++--
>   docs/specs/index.rst   | 4 ++--
>   docs/system/index.rst  | 4 ++--
>   docs/tools/index.rst   | 4 ++--
>   docs/user/index.rst    | 4 ++--
>   6 files changed, 12 insertions(+), 12 deletions(-)
> 
> diff --git a/docs/devel/index.rst b/docs/devel/index.rst
> index 7c424ea6d7..60039faa68 100644
> --- a/docs/devel/index.rst
> +++ b/docs/devel/index.rst
> @@ -1,8 +1,8 @@
>   .. This is the top level page for the 'devel' manual.
>   
>   
> -QEMU Developer's Guide
> -======================
> +Developer Information
> +=====================
>   
>   This manual documents various parts of the internals of QEMU.
>   You only need to read it if you are interested in reading or
> diff --git a/docs/interop/index.rst b/docs/interop/index.rst
> index 95d56495f6..219a5e5fc5 100644
> --- a/docs/interop/index.rst
> +++ b/docs/interop/index.rst
> @@ -1,8 +1,8 @@
>   .. This is the top level page for the 'interop' manual.
>   
>   
> -QEMU System Emulation Management and Interoperability Guide
> -===========================================================
> +System Emulation Management and Interoperability
> +================================================
>   
>   This manual contains documents and specifications that are useful
>   for making QEMU interoperate with other software.
> diff --git a/docs/specs/index.rst b/docs/specs/index.rst
> index 1b0eb979d5..7b08314d33 100644
> --- a/docs/specs/index.rst
> +++ b/docs/specs/index.rst
> @@ -1,8 +1,8 @@
>   .. This is the top level page for the 'specs' manual
>   
>   
> -QEMU System Emulation Guest Hardware Specifications
> -===================================================
> +System Emulation Guest Hardware Specifications
> +==============================================
>   
>   
>   Contents:
> diff --git a/docs/system/index.rst b/docs/system/index.rst
> index 6ad9c93806..02d0707181 100644
> --- a/docs/system/index.rst
> +++ b/docs/system/index.rst
> @@ -1,8 +1,8 @@
>   .. This is the top level page for the 'system' manual.
>   
>   
> -QEMU System Emulation User's Guide
> -==================================
> +System Emulation
> +================
>   
>   This manual is the overall guide for users using QEMU
>   for full system emulation (as opposed to user-mode emulation).
> diff --git a/docs/tools/index.rst b/docs/tools/index.rst
> index 3a5829c17a..d923834a73 100644
> --- a/docs/tools/index.rst
> +++ b/docs/tools/index.rst
> @@ -1,8 +1,8 @@
>   .. This is the top level page for the 'tools' manual
>   
>   
> -QEMU Tools Guide
> -================
> +Tools
> +=====
>   
>   
>   Contents:
> diff --git a/docs/user/index.rst b/docs/user/index.rst
> index e030dadf65..a5b47459ec 100644
> --- a/docs/user/index.rst
> +++ b/docs/user/index.rst
> @@ -1,8 +1,8 @@
>   .. This is the top level page for the 'user' manual.
>   
>   
> -QEMU User Mode Emulation User's Guide
> -=====================================
> +User Mode Emulation
> +===================
>   
>   This manual is the overall guide for users using QEMU
>   for user-mode emulation.  In this mode, QEMU can launch
>