[PATCH 1/3] docs: kbase: Convert 'kbase' article registry to RST

Peter Krempa posted 3 patches 4 years, 3 months ago
[PATCH 1/3] docs: kbase: Convert 'kbase' article registry to RST
Posted by Peter Krempa 4 years, 3 months ago
Signed-off-by: Peter Krempa <pkrempa@redhat.com>
---
 docs/kbase.html.in | 54 ----------------------------------------------
 docs/kbase.rst     | 43 ++++++++++++++++++++++++++++++++++++
 docs/meson.build   |  2 +-
 3 files changed, 44 insertions(+), 55 deletions(-)
 delete mode 100644 docs/kbase.html.in
 create mode 100644 docs/kbase.rst

diff --git a/docs/kbase.html.in b/docs/kbase.html.in
deleted file mode 100644
index 3ca0d0734d..0000000000
--- a/docs/kbase.html.in
+++ /dev/null
@@ -1,54 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <body class="docs">
-    <h1>Knowledge base</h1>
-
-    <div class="panel">
-      <dl>
-        <dt><a href="kbase/locking.html">Disk locking</a></dt>
-        <dd>Ensuring exclusive guest access to disks with
-          <a href="kbase/locking-lockd.html">virtlockd</a> or
-          <a href="kbase/locking-sanlock.html">Sanlock</a></dd>
-
-        <dt><a href="kbase/secureusage.html">Secure usage</a></dt>
-        <dd>Secure usage of the libvirt APIs</dd>
-
-        <dt><a href="kbase/s390_protected_virt.html">Protected virtualization on s390</a></dt>
-        <dd>Running secure s390 guests with IBM Secure Execution</dd>
-
-        <dt><a href="kbase/launch_security_sev.html">Launch security</a></dt>
-        <dd>Securely launching VMs with AMD SEV</dd>
-
-        <dt><a href="kbase/domainstatecapture.html">Domain state
-            capture</a></dt>
-        <dd>Comparison between different methods of capturing domain
-          state</dd>
-
-        <dt><a href="kbase/rpm-deployment.html">RPM deployment</a></dt>
-        <dd>Explanation of the different RPM packages and illustration of
-          which to pick for installation</dd>
-
-        <dt><a href="kbase/backing_chains.html">Backing chain management</a></dt>
-        <dd>Explanation of how disk backing chain specification impacts libvirt's
-          behaviour and basic troubleshooting steps of disk problems.</dd>
-
-        <dt><a href="kbase/qemu-passthrough-security.html">Security with QEMU passthrough</a></dt>
-        <dd>Examination of the security protections used for QEMU and how they need
-          configuring to allow use of QEMU passthrough with host files/devices.</dd>
-
-        <dt><a href="kbase/virtiofs.html">Virtio-FS</a></dt>
-        <dd>Share a filesystem between the guest and the host</dd>
-
-        <dt><a href="kbase/kvm-realtime.html">KVM real time</a></dt>
-        <dd>Run real time workloads in guests on a KVM hypervisor</dd>
-
-        <dt><a href="kbase/incrementalbackupinternals.html">Incremental backup internals</a></dt>
-        <dd>Incremental backup implementation details relevant for users</dd>
-      </dl>
-    </div>
-
-    <br class="clear"/>
-
-  </body>
-</html>
diff --git a/docs/kbase.rst b/docs/kbase.rst
new file mode 100644
index 0000000000..509fb6e34e
--- /dev/null
+++ b/docs/kbase.rst
@@ -0,0 +1,43 @@
+==============
+Knowledge base
+==============
+
+.. container:: panel
+
+   `Disk locking <kbase/locking.html>`__
+      Ensuring exclusive guest access to disks with
+      `virtlockd <kbase/locking-lockd.html>`__ or
+      `Sanlock <kbase/locking-sanlock.html>`__
+
+   `Secure usage <kbase/secureusage.html>`__
+      Secure usage of the libvirt APIs
+
+   `Protected virtualization on s390 <kbase/s390_protected_virt.html>`__
+      Running secure s390 guests with IBM Secure Execution
+
+   `Launch security <kbase/launch_security_sev.html>`__
+      Securely launching VMs with AMD SEV
+
+   `Domain state capture <kbase/domainstatecapture.html>`__
+      Comparison between different methods of capturing domain state
+
+   `RPM deployment <kbase/rpm-deployment.html>`__
+      Explanation of the different RPM packages and illustration of which to
+      pick for installation
+
+   `Backing chain management <kbase/backing_chains.html>`__
+      Explanation of how disk backing chain specification impacts libvirt's
+      behaviour and basic troubleshooting steps of disk problems.
+
+   `Security with QEMU passthrough <kbase/qemu-passthrough-security.html>`__
+      Examination of the security protections used for QEMU and how they need
+      configuring to allow use of QEMU passthrough with host files/devices.
+
+   `Virtio-FS <kbase/virtiofs.html>`__
+      Share a filesystem between the guest and the host
+
+   `KVM real time <kbase/kvm-realtime.html>`__
+      Run real time workloads in guests on a KVM hypervisor
+
+   `Incremental backup internals <kbase/incrementalbackupinternals.html>`__
+      Incremental backup implementation details relevant for users
diff --git a/docs/meson.build b/docs/meson.build
index c2d7fd1bf4..2f06e8eace 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -87,7 +87,6 @@ docs_html_in_files = [
   'index',
   'internals',
   'java',
-  'kbase',
   'logging',
   'migration',
   'nss',
@@ -119,6 +118,7 @@ docs_rst_files = [
   'formatbackup',
   'formatcheckpoint',
   'hacking',
+  'kbase',
   'libvirt-go',
   'libvirt-go-xml',
   'newreposetup',
-- 
2.26.2