Skip to content

Commit

Permalink
Hugo docs: Update to upstream Hugo Relearn 7.3.2
Browse files Browse the repository at this point in the history
  • Loading branch information
bernhardkaindl committed Feb 2, 2025
1 parent 19f164f commit d65eb4a
Show file tree
Hide file tree
Showing 142 changed files with 64 additions and 332 deletions.
22 changes: 12 additions & 10 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ an enhanced fork of the popular Hugo Learn theme.

### Supported versions of Hugo and the Hugo Relearn theme

Hugo Relearn 6.4.0 is currently used (defined by a git tag in `doc/go.mod`).
Hugo Relearn 7.3.2 is currently used (defined by a git tag in `doc/go.mod`).

- The minimum Hugo version required by the Relearn theme is 0.126.0.
- The current Ubuntu `snap` (which provides 0.142.0) also works.
Expand Down Expand Up @@ -72,31 +72,33 @@ Backported fixes to support newer Hugo versions:
The fixes for those issues were backported from the Hugo Relearn v7.x.x theme.
When updating to Hugo Relearn 7.x.x, please remove them (if possible).

#### Upgrading to the Hugo Relearn 7.x.x theme versions
#### Tips when upgradubg to newer Hugo Relearn versions

The partials in `layouts/partials` contain code for rendering the XenAPI releases
and class reference:
Check the release notes of the Hugo Relearn theme for breaking changes:
https://mcshelby.github.io/hugo-theme-relearn/introduction/releasenotes

These custom partials need updates to support the breaking changes of Hugo Relearn
7.0.0. Otherwise, the Relearn theme menu sidebar on those pages would be missing.
These are the pages to verify for correct menu rendering when updating to 7.x.x:
These pages might need review when making changes as their content is
generated by layouts/partials/content.html:

- XenAPI Reference: <https://xapi-project.github.io/new-docs/xen-api/classes>
- XenAPI Releases: <https://xapi-project.github.io/new-docs/xen-api/releases>

For a summary of the partials supported by the Hugo Relearn theme, see:
https://mcshelby.github.io/hugo-theme-relearn/configuration/customization/partials

Hint: For upgrading the Hugo Relearn theme, you can use:

```bash
cd doc; hugo mod get -u github.com/McShelby/hugo-theme-relearn@6.4.0
cd doc; hugo mod get -u github.com/McShelby/hugo-theme-relearn@7.4.0
```

#### Summary

Hugo Relearn >= 5.23 and Relearn 6.x.x work now, 7.x.x is work in progress.
Hugo >= 0.126 and the Hugo Relearn >= 7.3.2 are supported to render the docs.

#### References

- Changes with Relearn 6.x:
<https://mcshelby.github.io/hugo-theme-relearn/introduction/releasenotes/6/#6-0-0>
- Breaking changes with Relearn 7.x (to be supported):
- Breaking changes with Relearn 7.x:
<https://mcshelby.github.io/hugo-theme-relearn/introduction/releasenotes/7/#7-0-0>
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/_index.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
+++
title = "XenAPI Reference"
layout = "class"
type = "xenapi"
weight = 100
+++

Expand Down
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/auth.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "auth"
layout = "class"
type = "xenapi"
class = "auth"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/blob.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "blob"
layout = "class"
type = "xenapi"
class = "blob"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/bond.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "Bond"
layout = "class"
type = "xenapi"
class = "Bond"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/certificate.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "Certificate"
layout = "class"
type = "xenapi"
class = "Certificate"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/cluster.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "Cluster"
layout = "class"
type = "xenapi"
class = "Cluster"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/cluster_host.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "Cluster_host"
layout = "class"
type = "xenapi"
class = "Cluster_host"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/console.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "console"
layout = "class"
type = "xenapi"
class = "console"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/crashdump.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "crashdump"
layout = "class"
type = "xenapi"
class = "crashdump"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/data_source.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "data_source"
layout = "class"
type = "xenapi"
class = "data_source"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/dr_task.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "DR_task"
layout = "class"
type = "xenapi"
class = "DR_task"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/event.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "event"
layout = "class"
type = "xenapi"
class = "event"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/feature.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "Feature"
layout = "class"
type = "xenapi"
class = "Feature"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/gpu_group.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "GPU_group"
layout = "class"
type = "xenapi"
class = "GPU_group"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/host.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "host"
layout = "class"
type = "xenapi"
class = "host"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/host_cpu.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "host_cpu"
layout = "class"
type = "xenapi"
class = "host_cpu"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/host_crashdump.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "host_crashdump"
layout = "class"
type = "xenapi"
class = "host_crashdump"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/host_metrics.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "host_metrics"
layout = "class"
type = "xenapi"
class = "host_metrics"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/host_patch.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "host_patch"
layout = "class"
type = "xenapi"
class = "host_patch"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/lvhd.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "LVHD"
layout = "class"
type = "xenapi"
class = "LVHD"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/message.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "message"
layout = "class"
type = "xenapi"
class = "message"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/network.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "network"
layout = "class"
type = "xenapi"
class = "network"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/network_sriov.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "network_sriov"
layout = "class"
type = "xenapi"
class = "network_sriov"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/observer.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "Observer"
layout = "class"
type = "xenapi"
class = "Observer"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/pbd.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "PBD"
layout = "class"
type = "xenapi"
class = "PBD"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/pci.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "PCI"
layout = "class"
type = "xenapi"
class = "PCI"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/pgpu.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "PGPU"
layout = "class"
type = "xenapi"
class = "PGPU"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/pif.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "PIF"
layout = "class"
type = "xenapi"
class = "PIF"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/pif_metrics.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "PIF_metrics"
layout = "class"
type = "xenapi"
class = "PIF_metrics"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/pool.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "pool"
layout = "class"
type = "xenapi"
class = "pool"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/pool_patch.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "pool_patch"
layout = "class"
type = "xenapi"
class = "pool_patch"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/pool_update.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "pool_update"
layout = "class"
type = "xenapi"
class = "pool_update"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/probe_result.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "probe_result"
layout = "class"
type = "xenapi"
class = "probe_result"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/pusb.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "PUSB"
layout = "class"
type = "xenapi"
class = "PUSB"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/pvs_cache_storage.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "PVS_cache_storage"
layout = "class"
type = "xenapi"
class = "PVS_cache_storage"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/pvs_proxy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "PVS_proxy"
layout = "class"
type = "xenapi"
class = "PVS_proxy"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/pvs_server.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "PVS_server"
layout = "class"
type = "xenapi"
class = "PVS_server"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/pvs_site.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "PVS_site"
layout = "class"
type = "xenapi"
class = "PVS_site"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/repository.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "Repository"
layout = "class"
type = "xenapi"
class = "Repository"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/role.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "role"
layout = "class"
type = "xenapi"
class = "role"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/sdn_controller.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "SDN_controller"
layout = "class"
type = "xenapi"
class = "SDN_controller"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/secret.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "secret"
layout = "class"
type = "xenapi"
class = "secret"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/session.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "session"
layout = "class"
type = "xenapi"
class = "session"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/sm.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "SM"
layout = "class"
type = "xenapi"
class = "SM"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/sr.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "SR"
layout = "class"
type = "xenapi"
class = "SR"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/sr_stat.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "sr_stat"
layout = "class"
type = "xenapi"
class = "sr_stat"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/subject.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "subject"
layout = "class"
type = "xenapi"
class = "subject"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/task.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "task"
layout = "class"
type = "xenapi"
class = "task"
+++
2 changes: 0 additions & 2 deletions doc/content/xen-api/classes/tunnel.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
+++
title = "tunnel"
layout = "class"
type = "xenapi"
class = "tunnel"
+++
Loading

0 comments on commit d65eb4a

Please sign in to comment.