8 a.m.
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(a)redhat.com>
---
docs/Makefile.am | 15 ++++++++++++++-
docs/docs.html.in | 9 ++-------
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
7 files changed, 16 insertions(+), 8 deletions(-)
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/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