Minor doc fix | Patchew

[PATCH] Minor doc fix

Sebastian Mitterle posted 1 patch 4 years, 1 month ago

Download mbox

Test syntax-check failed

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/20200319171323.10719-1-smitterl@redhat.com

docs/formatbackup.html.in | 2 +-
docs/kbase.html.in        | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)

Expand all Fold all

[PATCH] Minor doc fix

Posted by Sebastian Mitterle 4 years, 1 month ago

1. Fix link to knowledge base article
2. Use <h1> to make sure kbase.html has page title

Signed-off-by Sebastian Mitterle <smitterl@redhat.com>
---
 docs/formatbackup.html.in | 2 +-
 docs/kbase.html.in        | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/formatbackup.html.in b/docs/formatbackup.html.in
index 543d913072..55acd13ddc 100644
--- a/docs/formatbackup.html.in
+++ b/docs/formatbackup.html.in
@@ -14,7 +14,7 @@
       description of the actions to perform, as well as an optional
       second XML document <a href="formatcheckpoint.html">describing a
       checkpoint</a> to create at the same point in time. See
-      also <a href="domainstatecapture.html">a comparison</a> between
+      also <a href="kbase/domainstatecapture.html">a comparison</a> between
       the various state capture APIs.
     </p>
     <p>
diff --git a/docs/kbase.html.in b/docs/kbase.html.in
index 7055f4fda4..c586e0f676 100644
--- a/docs/kbase.html.in
+++ b/docs/kbase.html.in
@@ -2,7 +2,7 @@
 <!DOCTYPE html>
 <html xmlns="http://www.w3.org/1999/xhtml">
   <body class="docs">
-    <h2>Knowledge base</h2>
+    <h1>Knowledge base</h1>
 
     <div class="panel">
       <dl>
-- 
2.21.0

Re: [PATCH] Minor doc fix

Posted by Ján Tomko 4 years, 1 month ago

On a Thursday in 2020, Sebastian Mitterle wrote:
>1. Fix link to knowledge base article
>2. Use <h1> to make sure kbase.html has page title

These are actually two fixes.
I've split them up using these bullet points as commit messages.

>
>Signed-off-by Sebastian Mitterle <smitterl@redhat.com>

You can use 'git commit -s' to add your sign-off line.

>---
> docs/formatbackup.html.in | 2 +-
> docs/kbase.html.in        | 2 +-
> 2 files changed, 2 insertions(+), 2 deletions(-)
>

Reviewed-by: Ján Tomko <jtomko@redhat.com>
and pushed

Jano