The anchors are based on the article or chapter headers, thus they are not 100% permanent. Especially with pages generated from RST. Signed-off-by: Peter Krempa <pkrempa(a)redhat.com&gt; --- docs/page.xsl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/page.xsl b/docs/page.xsl index 07bfc52a4c..9e0d4e0954 100644 --- a/docs/page.xsl +++ b/docs/page.xsl @@ -194,10 +194,10 @@ <xsl:element name="{name()}"> <xsl:apply-templates mode="copy" /> <xsl:if test="./html:a/@id"> - <a class="headerlink" href="#{html:a/@id}" title="Permalink to this headline">&#xb6;</a> + <a class="headerlink" href="#{html:a/@id}" title="Link to this headline">&#xb6;</a> </xsl:if> <xsl:if test="parent::html:div[@class='section']"> - <a class="headerlink" href="#{../@id}" title="Permalink to this headline">&#xb6;</a> + <a class="headerlink" href="#{../@id}" title="Link to this headline">&#xb6;</a> </xsl:if> </xsl:element> </xsl:template> -- 2.26.2

Move docs/kbase.rst to docs/kbase/index.rst so that the directory itself shows our index page rather than the autogenerated list of files by the webserver. Signed-off-by: Peter Krempa <pkrempa(a)redhat.com&gt; --- docs/docs.html.in | 2 +- docs/index.html.in | 2 +- docs/{kbase.rst => kbase/index.rst} | 32 ++++++++++++++--------------- docs/kbase/meson.build | 1 + docs/meson.build | 1 - 5 files changed, 19 insertions(+), 19 deletions(-) rename docs/{kbase.rst => kbase/index.rst} (57%) diff --git a/docs/docs.html.in b/docs/docs.html.in index 920a773d79..77d5c78b30 100644 --- a/docs/docs.html.in +++ b/docs/docs.html.in @@ -126,7 +126,7 @@ <dt><a href="hvsupport.html">Driver support</a></dt> <dd>matrix of API support per hypervisor per release</dd> - <dt><a href="kbase.html">Knowledge Base</a></dt> + <dt><a href="kbase/index.html">Knowledge Base</a></dt> <dd>Task oriented guides to key features</dd> </dl> </div> diff --git a/docs/index.html.in b/docs/index.html.in index 97421c5e7b..3057a052dd 100644 --- a/docs/index.html.in +++ b/docs/index.html.in @@ -64,7 +64,7 @@ <dt><a href="https://wiki.libvirt.org">Wiki</a></dt> <dd>Read further community contributed content</dd> - <dt><a href="https://libvirt.org/kbase.html">Knowledge base</a></dt> + <dt><a href="https://libvirt.org/kbase/index.html">Knowledge base</a></dt> <dd>Learn more about libvirt through knowledge base</dd> </dl> </div> diff --git a/docs/kbase.rst b/docs/kbase/index.rst similarity index 57% rename from docs/kbase.rst rename to docs/kbase/index.rst index a6de4b1a1a..cf424bd099 100644 --- a/docs/kbase.rst +++ b/docs/kbase/index.rst @@ -4,50 +4,50 @@ Knowledge base .. container:: panel widepanel - `Debug logs <kbase/debuglogs.html>`__ + `Debug logs <debuglogs.html>`__ Configuration of logging and tips on how to file a good bug report. - `Disk locking <kbase/locking.html>`__ + `Disk locking <locking.html>`__ Ensuring exclusive guest access to disks with - `virtlockd <kbase/locking-lockd.html>`__ or - `Sanlock <kbase/locking-sanlock.html>`__ + `virtlockd <locking-lockd.html>`__ or + `Sanlock <locking-sanlock.html>`__ - `Secure usage <kbase/secureusage.html>`__ + `Secure usage <secureusage.html>`__ Secure usage of the libvirt APIs - `Protected virtualization on s390 <kbase/s390_protected_virt.html>`__ + `Protected virtualization on s390 <s390_protected_virt.html>`__ Running secure s390 guests with IBM Secure Execution - `Launch security <kbase/launch_security_sev.html>`__ + `Launch security <launch_security_sev.html>`__ Securely launching VMs with AMD SEV - `Domain state capture <kbase/domainstatecapture.html>`__ + `Domain state capture <domainstatecapture.html>`__ Comparison between different methods of capturing domain state - `RPM deployment <kbase/rpm-deployment.html>`__ + `RPM deployment <rpm-deployment.html>`__ Explanation of the different RPM packages and illustration of which to pick for installation - `Backing chain management <kbase/backing_chains.html>`__ + `Backing chain management <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>`__ + `Security with QEMU passthrough <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. - `Systemtap <kbase/systemtap.html>`__ + `Systemtap <systemtap.html>`__ Explanation of how to use systemtap for libvirt tracing. - `Virtio-FS <kbase/virtiofs.html>`__ + `Virtio-FS <virtiofs.html>`__ Share a filesystem between the guest and the host - `KVM real time <kbase/kvm-realtime.html>`__ + `KVM real time <kvm-realtime.html>`__ Run real time workloads in guests on a KVM hypervisor - `Incremental backup internals <kbase/incrementalbackupinternals.html>`__ + `Incremental backup internals <incrementalbackupinternals.html>`__ Incremental backup implementation details relevant for users - `VM migration internals <kbase/migrationinternals.html>`__ + `VM migration internals <migrationinternals.html>`__ VM migration implementation details, complementing the info in `migration <migration.html>`__ diff --git a/docs/kbase/meson.build b/docs/kbase/meson.build index c0fa72ff35..7b4e7abbd3 100644 --- a/docs/kbase/meson.build +++ b/docs/kbase/meson.build @@ -3,6 +3,7 @@ docs_kbase_files = [ 'debuglogs', 'domainstatecapture', 'incrementalbackupinternals', + 'index', 'kvm-realtime', 'launch_security_sev', 'locking-lockd', diff --git a/docs/meson.build b/docs/meson.build index a915d6252a..0e96123797 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -118,7 +118,6 @@ docs_rst_files = [ 'formatdomain', 'glib-adoption', 'hacking', - 'kbase', 'libvirt-go', 'libvirt-go-xml', 'newreposetup', -- 2.26.2

Split the existing list of kbase articles into a 'Usage' category and into 'Internals/Debugging'. This will later represent the two columns on the web page. Signed-off-by: Peter Krempa <pkrempa(a)redhat.com&gt; --- docs/kbase/index.rst | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/kbase/index.rst b/docs/kbase/index.rst index b3e6e5461b..f9e42f211f 100644 --- a/docs/kbase/index.rst +++ b/docs/kbase/index.rst @@ -2,8 +2,8 @@ Knowledge base ============== -`Debug logs <debuglogs.html>`__ - Configuration of logging and tips on how to file a good bug report. +Usage +----- `Disk locking <locking.html>`__ Ensuring exclusive guest access to disks with @@ -34,15 +34,21 @@ Knowledge base Examination of the security protections used for QEMU and how they need configuring to allow use of QEMU passthrough with host files/devices. -`Systemtap <systemtap.html>`__ - Explanation of how to use systemtap for libvirt tracing. - `Virtio-FS <virtiofs.html>`__ Share a filesystem between the guest and the host `KVM real time <kvm-realtime.html>`__ Run real time workloads in guests on a KVM hypervisor +Internals / Debugging +--------------------- + +`Debug logs <debuglogs.html>`__ + Configuration of logging and tips on how to file a good bug report. + +`Systemtap <systemtap.html>`__ + Explanation of how to use systemtap for libvirt tracing. + `Incremental backup internals <incrementalbackupinternals.html>`__ Incremental backup implementation details relevant for users -- 2.26.2

Re-style the knowledge base to look like the 'docs.html' page. We still have room to add one more column. Signed-off-by: Peter Krempa <pkrempa(a)redhat.com&gt; --- docs/libvirt.css | 38 ++++++++++++++++++++++++++++---------- 1 file changed, 28 insertions(+), 10 deletions(-) diff --git a/docs/libvirt.css b/docs/libvirt.css index bb71244a7e..5195588a8f 100644 --- a/docs/libvirt.css +++ b/docs/libvirt.css @@ -106,7 +106,8 @@ #index.document, #docs.document, -#hvsupport.document +#hvsupport.document, +#knowledge-base.document { width: inherit; } @@ -395,14 +396,17 @@ h6:hover > a.headerlink { visibility: visible; } -div.panel { +div.panel, +#knowledge-base .section +{ width: 24%; margin-left: 7%; float: left; background: rgb(230, 230, 230); } -div.panel h2 { +div.panel h2, +#knowledge-base .section h1 { margin-top: 0px; padding: 0.5em; padding-left: 1em; @@ -419,6 +423,11 @@ div.panel h2 { height: 300px; } +#knowledge-base.document > h1 { + text-align: center; + padding: 1em; +} + #docs.document h1 { visibility: hidden; } @@ -475,29 +484,38 @@ br.clear { font-size: smaller; } -div.panel dd { +div.panel dd, +#knowledge-base dd { font-size: smaller; } -div.panel a { +div.panel a, +#knowledge-base a { text-decoration: none; } div.panel ul, div.panel p, -div.panel dl { +div.panel dl, +#knowledge-base ul, +#knowledge-base p, +#knowledge-base dl { padding: 0.5em; margin: 0px; } - -div.panel ul { +div.panel ul, +#knowledge-base ul { margin-left: 1em; } -div.panel dt { + +div.panel dt, +#knowledge-base dt { margin: 0px; } -div.panel dd { + +div.panel dd, +#knowledge-base dd { margin: 0px; margin-bottom: 1em; } -- 2.26.2