Docs update to upstream hugo relearn 7.3.2

[bernhardkaindl]

Thanks for the reviews and review comments!

The incremental change before the merge applied the required incremental fixes (see the Compare link of it).

• Review comment from Pau applied: Reverted not running the required pull_request workflows.
• Review comment from Pau applied: Fixed not even temporarily using private forks: Squashed commits
  • While squashing those changes, I:
    • Split change from menuTitle to linkTitle into an initial commit (can be done first)
    • Squashed the changes for doc/hugo.toml into one commit.
      • and extracted the change to hugo.toml into one commit (support current Hugo versions)
    • Squashed the changes for doc/README.md into one commit (no intermediate changes)
    • I found one inadvertent revert of a previous simplification: I removed this accidental revert.

---

Hugo docs: Fix upstream Hugo compatibility:

• Includes the fixed commit from Hugo docs: Support newer Hugo and Hugo Relearn versions; update README #6264, and
• Adds a 2nd commit to complete the fix for upstream compatibility.

Update Hugo version support to work with the current Hugo version

This PR fixes using the Ubuntu snap to render the Hugo docs.

Relearn 7.x completely REMOVED the header.html and footer.html partials
Partials that useed them are:

• https://github.com/xapi-project/xen-api/blob/master/doc/layouts/xenapi/class.html
• https://github.com/xapi-project/xen-api/blob/master/doc/layouts/xenapi/release.html
  To update to 7.x, these had to be moved to the content.html partial, as documented.

Changes:

• Hugo Relearn 6.x uses the linkTitle front matter option now:
  Quote from the release notes: The front matter option menuTitle deprecated in 5.24.0 was removed in favour for Hugo’s linkTitle.
• Newer versions of Hugo require the option unsafe = true to include raw HTML.
• Two Hugo Relearn 6.x partials need fixes for newer versions of Hugo.

Update doc/README.md accordingly

• Update the information on supported versions.
• Add information on the breaking changes in Hugo Relearn 7.x.x to watch out for.
• While at it, fix/improve the formatting of doc/README.md:
  • Spelling fixes/improvements
  • Fix markdown linting errors (empty lines for spacing, no bare links)
    • Tidy up the document structure

[robhoes]

I've tried this and it appears to work. Thanks!

[robhoes]

But why are the 11 checks not running?

[psafont]

But why are the 11 checks not running?

Because we merged a change that disabled them if the related content wasn't changed. But they are required in order to be able to merge. Unfortunately these cannot be configured to be required depending on the changed content.

@bernhardkaindl please revert the changes to disable the runs, theya re needed in roder to make the merge queue to work

[bernhardkaindl]

👍 to @psafont (thanks for the approval already), @robhoes:

Thanks for the reviews and review comments!

---

Summary of the incremental changes:

I applied the required fixes and re-organized the changes in cumulative commits.

The incremental change consists only of the required incremental fixes (see the Compare link of it above):
bernhardkaindl force-pushed the docs-update-to-upstream-Hugo-Relearn-7.3.2 branch from e92341c to 7f64d07 Compare

👍 Review comment from Pau applied: Reverted not running the required pull_request workflows ->workflows are fixed.
👍 Review comment from Pau applied: Fixed not even temporarily using private forks -> Squashed those commits.

• While squashing those changes, I:
  • Split change from menuTitle to linkTitle into an initial commit (can be done first)
  • Squashed the changes for doc/hugo.toml into one commit.
    • and extracted the change to hugo.toml into one commit (support current Hugo versions)
  • Squashed the changes for doc/README.md into one commit (no intermediate changes)
  • I found one inadvertent revert of a previous simplification: I removed this accidental revert.

It is ready for review again.