Skip to content

docs: Update docs/README.md and Hugo Relearn to 5.23.0 #6251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

bernhardkaindl
Copy link
Collaborator

@bernhardkaindl bernhardkaindl commented Jan 26, 2025

Minor updates of the Hugo documentation:

  • The current Ubuntu snap package of Hugo is not supported by the docs.
    We should take a first minor step towards fixing this.

  • doc/README.md is outdated and should be updated (new version).
    It says that the Ubuntu snap of Hugo works, but it does not anymore.
    Fix this by updating the outdated information.

  • An initial fix is to update the Relearn theme from 5.20.x to 5.23.0:

    • It does not introduce breaking changes.
    • It introduces more straightforward page links and deprecates older syntax.
    • Fix the warnings by updating relative links accordingly.

A preview is available on my site: https://xenserver-next.github.io/xen-api/index.html

@bernhardkaindl bernhardkaindl force-pushed the docs-update-README-and-hugo-relearn-to-5.23 branch from b318cea to d126e7c Compare January 26, 2025 17:37
@bernhardkaindl bernhardkaindl force-pushed the docs-update-README-and-hugo-relearn-to-5.23 branch from d126e7c to 31dab81 Compare January 26, 2025 18:17
Minor updates of the Hugo documentation:

- The current Ubuntu snap package of Hugo is not supported by the docs.
  We should take a first minor step towards fixing this.

- `doc/README.md` is outdated and should be updated.
  It says that the Ubuntu snap of Hugo works, but it does not anymore.
  Fix this by updating the outdated information.

- An initial fix is to update the Relearn theme from 5.20.x to 5.23.0:
  - It does not introduce breaking changes.
  - It introduces more straightforward page links and deprecates older syntax.
  - Fix the warnings by updating relative links accordingly.

Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
@bernhardkaindl bernhardkaindl force-pushed the docs-update-README-and-hugo-relearn-to-5.23 branch from 31dab81 to 458b138 Compare January 26, 2025 20:31
@bernhardkaindl
Copy link
Collaborator Author

bernhardkaindl commented Jan 27, 2025

@robhoes Can you review this PR and check if you like to merge it? (Pau and Christian approved it)

GitHub tells me that I no longer have write access and therefore cannot merge anymore.

Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
Copy link
Collaborator Author

@bernhardkaindl bernhardkaindl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When updating to newer versions of the Hugo Relearn theme,
Hugo/Relearn warned about a few broken links.
The broken links are currently live on https://xapi-project.github.io/new-docs/,
and I tested the fixes on top of this PR. This comment gives the details about the new commit to
Fix currently broken links to toolstack/features: HA, snapshots:

The cause is simple:
The old docs site had the features at /features/HA/HA.html and /features/snapshots/snapshots.html.
But on the new-docs site, they are below toolstack/features

Fix them to target the respective new-docs pages toolstack/features/HA and toolstack/features/snapshots, respectively.

The fixes are kept as relative links, so all of them are work in 3 environments:

  • In the fast Markdown review renderer in VS Code / Codium and its derivatives.
  • The local hugo server renderer
  • Deployment using GitHub Pages at different URLs.

Sample locations of the currently broken links for review:

Fix 3: Link from design/ocfs2 to (toolstack)/features/HA:
Old: https://xapi-project.github.io/new-docs/design/ocfs2:

New: https://xenserver-next.github.io/xen-api/design/ocfs2 (fix for review):

Fix 4: "Read more about Snapshots: the High-Level Feature." at on top of this page:
Old: https://xapi-project.github.io/new-docs/xen-api/topics/snapshots/ (link results in 404)
New: https://xenserver-next.github.io/xen-api/xen-api/topics/snapshots/ (review of the fixed link)

PS: I would have merged it already before this commit, but I lost the write permission needed for the merge.

Signed-off-by: Bernhard Kaindl <bernhard.kaindl@cloud.com>
Copy link
Contributor

@contificate contificate left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this, this is a good start in making the docs more readily buildable.

@robhoes robhoes added this pull request to the merge queue Jan 27, 2025
Merged via the queue into xapi-project:master with commit 0499324 Jan 27, 2025
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants