Skip to content

docs (talos hvm): add the What Is Talos Hypervisor overview page - #806

Closed
Iheanacho-ai wants to merge 1 commit into
siderolabs:mainfrom
Iheanacho-ai:talos-hvm-overview
Closed

Iheanacho-ai wants to merge 1 commit into
siderolabs:mainfrom
Iheanacho-ai:talos-hvm-overview

Conversation

@Iheanacho-ai

Copy link
Copy Markdown
Member

What

Adds public/hypervisor/overview/what-is-talos-hypervisor.mdx, the overview page for Talos Hypervisor. It covers what Talos Hypervisor is, how running Talos as the host differs from running it as a guest, the building blocks (content library, storage pool, virtual machine), and how it compares with KubeVirt.

Why

This is the Overview section of the Talos Hypervisor docs for TalosCon. It builds on the navigation in #805, and the combined PR at the end will bring all of the Talos Hypervisor PRs to main.

Change

  • public/hypervisor/overview/what-is-talos-hypervisor.mdx: new concept page.
  • Links to the ContentLibraryConfig, StoragePool, and VirtualMachineConfig reference pages point at talos/v1.15/reference/configuration/.... These resolve once the Talos v1.15 alpha docs are added.

Testing

  • Ran: make style-check-changed, make check-frontmatter-changed, and a link check against the v1.14 pages
  • Where: local checkout
  • By: an agent (Claude Code), plus a separate agent that fact-checked every claim against siderolabs/talos main at cf07b8a, citing file:line
  • Result: the style check passes. The fact-check found one wrong statement (disks in storage pools are not provisioned yet) and several overstated ones, all corrected. The frontmatter check reports the page as belonging to no known section, because public/hypervisor is registered in docs (talos hvm): add the Talos Hypervisor navigation structure #805. broken-links is expected to flag the v1.15 reference links and the link to Run your first virtual machine, which lands in a later PR. All of these clear in the combined PR.
  • Filled from outside the page: nothing. This is a concept page with no procedures, so there were no commands to run.

@github-actions

github-actions Bot commented Oct 6, 2026 •

Copy link
Copy Markdown

📋 Automated documentation review

An automated pass runs on documentation changes in every PR. The items below are suggestions to consider — advisory, not a merge gate.

Reviewed commit 015b8cb · 🔴 0 critical · 🟡 4 warning(s) · ⚪ 1 notice(s)

  • 🟡 public/hypervisor/overview/what-is-talos-hypervisor.mdx:20 — Links to /talos/v1.15/ reference pages that do not exist in this repository
    • Why: The ContentLibraryConfig, StoragePool and VirtualMachineConfig links point at /talos/v1.15/..., but the newest Talos version directory in the repo is public/talos/v1.14 and custom-variables.mdx still sets version to v1.14. All three links 404 today and make broken-links will fail.
    • Fix: Land the Talos v1.15 reference pages in the same change, or render ContentLibraryConfig, StoragePool and VirtualMachineConfig as unlinked code spans until v1.15 docs exist.
  • 🟡 public/hypervisor/overview/what-is-talos-hypervisor.mdx:32 — Next steps links to a getting-started page that does not exist
    • Why: ../getting-started/run-your-first-virtual-machine resolves to /hypervisor/getting-started/run-your-first-virtual-machine, which is not in the repo or this PR, so the page's only call to action dead-ends and make broken-links will fail.
    • Fix: Add public/hypervisor/getting-started/run-your-first-virtual-machine.mdx in the same change, or remove the Next steps section until that guide exists.
  • 🟡 public/hypervisor/overview/what-is-talos-hypervisor.mdx:1 — New page is not listed in any navigation YAML, so it will not appear on the site
    • Why: There is no hypervisor.yaml at the repo root and common.yaml still declares Talos Hypervisor as a soon:true homepage card, so this page is unreachable and make validate-docs-nav and make check-missing will fail.
    • Fix: Add a hypervisor.yaml nav file with an Overview group over hypervisor/overview, replace the soon:true card in common.yaml, then run make docs.json and commit the result.
  • 🟡 public/hypervisor/overview/what-is-talos-hypervisor.mdx:8 — Page never states the minimum Talos version required for Talos Hypervisor
    • Why: The hypervisor config documents exist only from Talos v1.15 upstream, while the site's current stable is v1.14; a reader on stable who follows this page will have VirtualMachineConfig rejected as an unknown document.
    • Fix: Talos Hypervisor requires Talos Linux v1.15 or later and the libvirtd system extension.

Notices, and the reviewer's full report, are in the run's doc-accuracy-report artifact.

@Iheanacho-ai
Iheanacho-ai marked this pull request as draft October 6, 2026 15:58
@github-actions

github-actions Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

📋 Automated documentation review

⚠️ The reviewer did not finish on commit 3cb3067 (it timed out or errored) — see the workflow run log. This run did not produce a result; any findings from an earlier run on this PR still stand.

@Iheanacho-ai
Iheanacho-ai marked this pull request as ready for review October 13, 2026 08:47
@github-project-automation github-project-automation Bot moved this from In Review to Approved in Planning Oct 13, 2026
Comment thread public/hypervisor/overview/what-is-talos-hypervisor.mdx Outdated
Comment thread public/hypervisor/overview/what-is-talos-hypervisor.mdx Outdated
Signed-off-by: Amarachi Iheanacho <amarachi.iheanacho@siderolabs.com>
@sterlingkoch

Copy link
Copy Markdown
Member

Merged as part of #867.

@github-project-automation github-project-automation Bot moved this from Approved to Done in Planning Oct 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

6 participants