[libvirt] [PATCH v2] docs: introduce a "knowledge base" for task oriented guides

Daniel P. Berrangé posted 1 patch 13 weeks ago
Test syntax-check passed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/20190708141411.21435-1-berrange@redhat.com
docs/Makefile.am                             | 15 +++++++++++-
docs/docs.html.in                            |  9 ++-----
docs/kbase.html.in                           | 25 ++++++++++++++++++++
docs/{ => kbase}/launch_security_sev.html.in |  0
docs/{ => kbase}/locking-lockd.html.in       |  0
docs/{ => kbase}/locking-sanlock.html.in     |  0
docs/{ => kbase}/locking.html.in             |  0
docs/{ => kbase}/secureusage.html.in         |  0
8 files changed, 41 insertions(+), 8 deletions(-)
create mode 100644 docs/kbase.html.in
rename docs/{ => kbase}/launch_security_sev.html.in (100%)
rename docs/{ => kbase}/locking-lockd.html.in (100%)
rename docs/{ => kbase}/locking-sanlock.html.in (100%)
rename docs/{ => kbase}/locking.html.in (100%)
rename docs/{ => kbase}/secureusage.html.in (100%)

[libvirt] [PATCH v2] docs: introduce a "knowledge base" for task oriented guides

Posted by Daniel P. Berrangé 13 weeks ago
The previously added AMD SEV doc was not linked from anywhere on the
website. Address this by introducing a new "Knowledge base" section
that can hold task oriented guide to various features. Moving the SEV,
disk locking and secure usage guides under this section.

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
 docs/Makefile.am                             | 15 +++++++++++-
 docs/docs.html.in                            |  9 ++-----
 docs/kbase.html.in                           | 25 ++++++++++++++++++++
 docs/{ => kbase}/launch_security_sev.html.in |  0
 docs/{ => kbase}/locking-lockd.html.in       |  0
 docs/{ => kbase}/locking-sanlock.html.in     |  0
 docs/{ => kbase}/locking.html.in             |  0
 docs/{ => kbase}/secureusage.html.in         |  0
 8 files changed, 41 insertions(+), 8 deletions(-)
 create mode 100644 docs/kbase.html.in
 rename docs/{ => kbase}/launch_security_sev.html.in (100%)
 rename docs/{ => kbase}/locking-lockd.html.in (100%)
 rename docs/{ => kbase}/locking-sanlock.html.in (100%)
 rename docs/{ => kbase}/locking.html.in (100%)
 rename docs/{ => kbase}/secureusage.html.in (100%)

diff --git a/docs/Makefile.am b/docs/Makefile.am
index 977be471ad..1cfa38dc80 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -132,6 +132,10 @@ internals_html_in = \
   $(patsubst $(srcdir)/%,%,$(wildcard $(srcdir)/internals/*.html.in))
 internals_html = $(internals_html_in:%.html.in=%.html)
 
+kbase_html_in = \
+  $(patsubst $(srcdir)/%,%,$(wildcard $(srcdir)/kbase/*.html.in))
+kbase_html = $(kbase_html_in:%.html.in=%.html)
+
 # Since we ship pre-built html in the tarball, we must also
 # ship the sources, even when those sources are themselves
 # generated.
@@ -187,6 +191,7 @@ EXTRA_DIST= \
   $(xml) $(qemu_xml) $(lxc_xml) $(admin_xml) $(fig) $(png) $(css) \
   $(javascript) $(logofiles) \
   $(internals_html_in) $(internals_html) $(fonts) \
+  $(kbase_html_in) $(kbase_html) \
   aclperms.htmlinc \
   hvsupport.pl \
   $(schema_DATA)
@@ -202,6 +207,7 @@ MAINTAINERCLEANFILES = \
   $(addprefix $(srcdir)/,$(apihtml)) \
   $(addprefix $(srcdir)/,$(devhelphtml)) \
   $(addprefix $(srcdir)/,$(internals_html)) \
+  $(addprefix $(srcdir)/,$(kbase_html)) \
   $(srcdir)/hvsupport.html.in $(srcdir)/aclperms.htmlinc
 
 timestamp="$(shell if test -n "$$SOURCE_DATE_EPOCH"; \
@@ -218,7 +224,8 @@ qemu_api: $(srcdir)/libvirt-qemu-api.xml $(srcdir)/libvirt-qemu-refs.xml
 lxc_api: $(srcdir)/libvirt-lxc-api.xml $(srcdir)/libvirt-lxc-refs.xml
 admin_api: $(srcdir)/libvirt-admin-api.xml $(srcdir)/libvirt-admin-refs.xml
 
-web: $(dot_html) $(internals_html) html/index.html devhelp/index.html
+web: $(dot_html) $(internals_html) $(kbase_html) \
+	html/index.html devhelp/index.html
 
 hvsupport.html: $(srcdir)/hvsupport.html.in
 
@@ -381,6 +388,9 @@ install-data-local:
 	$(mkinstalldirs) $(DESTDIR)$(HTML_DIR)/internals
 	for f in $(internals_html); do \
 	  $(INSTALL) -m 0644 $(srcdir)/$$f $(DESTDIR)$(HTML_DIR)/internals; done
+	$(mkinstalldirs) $(DESTDIR)$(HTML_DIR)/kbase
+	for f in $(kbase_html); do \
+	  $(INSTALL) -m 0644 $(srcdir)/$$f $(DESTDIR)$(HTML_DIR)/kbase; done
 	$(mkinstalldirs) $(DESTDIR)$(DEVHELP_DIR)
 	for file in $(devhelphtml) $(devhelppng) $(devhelpcss); do \
 	    $(INSTALL) -m 0644 $(srcdir)/$${file} $(DESTDIR)$(DEVHELP_DIR) ; \
@@ -405,6 +415,9 @@ uninstall-local:
 	for f in $(internals_html); do \
 	  rm -f $(DESTDIR)$(HTML_DIR)/$$f; \
 	done
+	for f in $(kbase_html); do \
+	  rm -f $(DESTDIR)$(HTML_DIR)/$$f; \
+	done
 	for f in $(devhelphtml) $(devhelppng) $(devhelpcss); do \
 	  rm -f $(DESTDIR)$(DEVHELP_DIR)/$$(basename $$f); \
 	done
diff --git a/docs/docs.html.in b/docs/docs.html.in
index c8674e1457..9e1ef6be41 100644
--- a/docs/docs.html.in
+++ b/docs/docs.html.in
@@ -86,11 +86,6 @@
         <dt><a href="uri.html">URI format</a></dt>
         <dd>The URI formats used for connecting to libvirt</dd>
 
-        <dt><a href="locking.html">Disk locking</a></dt>
-        <dd>Ensuring exclusive guest access to disks with
-          <a href="locking-lockd.html">virtlockd</a> or
-          <a href="locking-sanlock.html">Sanlock</a></dd>
-
         <dt><a href="cgroups.html">CGroups</a></dt>
         <dd>Control groups integration</dd>
 
@@ -120,8 +115,8 @@
         <dt><a href="hvsupport.html">Driver support</a></dt>
         <dd>matrix of API support per hypervisor per release</dd>
 
-        <dt><a href="secureusage.html">Secure usage</a></dt>
-        <dd>Secure usage of the libvirt APIs</dd>
+        <dt><a href="kbase.html">Knowledge Base</a></dt>
+        <dd>Task oriented guides to key features</dd>
       </dl>
     </div>
 
diff --git a/docs/kbase.html.in b/docs/kbase.html.in
new file mode 100644
index 0000000000..78f2a4e0c5
--- /dev/null
+++ b/docs/kbase.html.in
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <body class="docs">
+    <h2>Knowledge base</h2>
+
+    <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/launch_security_sev.html">Launch security</a></dt>
+        <dd>Securely launching VMs with AMD SEV</dd>
+      </dl>
+    </div>
+
+    <br class="clear"/>
+
+  </body>
+</html>
diff --git a/docs/launch_security_sev.html.in b/docs/kbase/launch_security_sev.html.in
similarity index 100%
rename from docs/launch_security_sev.html.in
rename to docs/kbase/launch_security_sev.html.in
diff --git a/docs/locking-lockd.html.in b/docs/kbase/locking-lockd.html.in
similarity index 100%
rename from docs/locking-lockd.html.in
rename to docs/kbase/locking-lockd.html.in
diff --git a/docs/locking-sanlock.html.in b/docs/kbase/locking-sanlock.html.in
similarity index 100%
rename from docs/locking-sanlock.html.in
rename to docs/kbase/locking-sanlock.html.in
diff --git a/docs/locking.html.in b/docs/kbase/locking.html.in
similarity index 100%
rename from docs/locking.html.in
rename to docs/kbase/locking.html.in
diff --git a/docs/secureusage.html.in b/docs/kbase/secureusage.html.in
similarity index 100%
rename from docs/secureusage.html.in
rename to docs/kbase/secureusage.html.in
-- 
2.21.0

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list

Re: [libvirt] [PATCH v2] docs: introduce a "knowledge base" for task oriented guides

Posted by Eric Blake 13 weeks ago
On 7/8/19 9:14 AM, Daniel P. Berrangé wrote:
> The previously added AMD SEV doc was not linked from anywhere on the
> website. Address this by introducing a new "Knowledge base" section
> that can hold task oriented guide to various features. Moving the SEV,
> disk locking and secure usage guides under this section.
> 
> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> ---
>  docs/Makefile.am                             | 15 +++++++++++-
>  docs/docs.html.in                            |  9 ++-----
>  docs/kbase.html.in                           | 25 ++++++++++++++++++++
>  docs/{ => kbase}/launch_security_sev.html.in |  0
>  docs/{ => kbase}/locking-lockd.html.in       |  0
>  docs/{ => kbase}/locking-sanlock.html.in     |  0
>  docs/{ => kbase}/locking.html.in             |  0
>  docs/{ => kbase}/secureusage.html.in         |  0
>  8 files changed, 41 insertions(+), 8 deletions(-)
>  create mode 100644 docs/kbase.html.in
>  rename docs/{ => kbase}/launch_security_sev.html.in (100%)
>  rename docs/{ => kbase}/locking-lockd.html.in (100%)
>  rename docs/{ => kbase}/locking-sanlock.html.in (100%)
>  rename docs/{ => kbase}/locking.html.in (100%)
>  rename docs/{ => kbase}/secureusage.html.in (100%)

Reviewed-by: Eric Blake <eblake@redhat.com>

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3226
Virtualization:  qemu.org | libvirt.org

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list

Re: [libvirt] [PATCH v2] docs: introduce a "knowledge base" for task oriented guides

Posted by Eric Blake 13 weeks ago
On 7/8/19 9:14 AM, Daniel P. Berrangé wrote:
> The previously added AMD SEV doc was not linked from anywhere on the
> website. Address this by introducing a new "Knowledge base" section
> that can hold task oriented guide to various features. Moving the SEV,
> disk locking and secure usage guides under this section.
> 
> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> ---

My pending work to add docs/domainstatecapture.html.in probably belongs
in this kbase/ as well. I'll rebase that on top of yours.

https://www.redhat.com/archives/libvir-list/2019-July/msg00239.html

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3226
Virtualization:  qemu.org | libvirt.org

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list