Skip to content

docs: add the Talos Director documentation - #802

Merged
sterlingkoch merged 3 commits into
mainfrom
director/initial-docs
Oct 2, 2026
Merged

sterlingkoch merged 3 commits into
mainfrom
director/initial-docs

Conversation

@sterlingkoch

@sterlingkoch sterlingkoch commented Oct 2, 2026 •

Copy link
Copy Markdown
Member

What

Adds Talos Director as a product on the docs site, with five pages:

  • Overview: what Director is, Limited Availability status (GA planned January 2027), and how to request access
  • Compute: Clusters, Hosts, Storage Pools
  • Kubernetes: Kubernetes Clusters

Director shows on the homepage as a live card in the Hypervisor row, and its navbar button links to siderolabs.com/getdirector.

Why

Director was announced on September 30, and prospects are asking for detailed information about it. These are the pages that are ready now.

Change

  • director.yaml: new product nav, family: hypervisor
  • public/director/: content. Clusters, Storage Pools, and Kubernetes Clusters are Lee Peal's pages from docs-staging#3, with two references to an undocumented DBaaS API removed. Hosts is adapted from Mark Soiseth's draft, including Add Host. Its deployment steps are as Mark observed them and have not been confirmed by engineering yet. The overview is new and follows the press release wording.
  • Makefile: director.yaml added to the docs.json and check-missing targets
  • tools/frontmatter-check: public/director registered (title, description)
  • Regenerated docs.json, index.mdx, product-nav.js

Conflicts with #801, which adds Director as a "coming soon" card. Whichever merges second drops that card, since this PR generates a live one.

Testing

  • Ran: make broken-links, make validate-docs-nav, make check-frontmatter-changed, make style-check-changed, make docs.json-local with a clean diff afterward
  • Where: local checkout, plus a local Mintlify preview (docs-mint dev)
  • By: an agent (Cursor), with Sterling reviewing
  • Result: all checks pass. The style checker warns on headings that name UI tabs (e.g. "Virtual Machines") and the product name, which is expected. Homepage card, sidebar, navbar button, and in-page anchors render correctly in the preview.
  • Filled from outside the page: nothing was checked against the live Director UI; screen descriptions are the writers' own.

Signed-off-by: Sterling Koch <sterling.koch@siderolabs.com>
@mintlify

mintlify Bot commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
siderolabs 🟢 Ready View Preview Oct 2, 2026, 7:05 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@github-actions

github-actions Bot commented Oct 2, 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 6db2b49 · 🔴 0 critical · 🟡 1 warning(s) · ⚪ 4 notice(s)

  • 🟡 public/director/kubernetes/kubernetes-clusters.mdx:82 — Preferred Host pins all control-plane VMs to one host, with no warning about etcd quorum or Control Plane Anti-Affinity
    • Why: The page says setting a Preferred Host migrates the control-plane VMs onto that host, but two rows earlier states that Control Plane Anti-Affinity exists so a single host failure cannot take out etcd quorum. A reader who sets a preferred host can put all three etcd members in one failure domain, so one host failure destroys the control plane.
    • Fix: Add to the Preferred Host row: 'Pinning the control plane to a single host places every etcd member in one failure domain. Leave Preferred Host set to Any for multi-node control planes.'

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

Signed-off-by: Sterling Koch <sterling.koch@siderolabs.com>
Signed-off-by: Sterling Koch <sterling.koch@siderolabs.com>
@sterlingkoch
sterlingkoch merged commit c986e73 into main Oct 2, 2026
6 checks passed

This branch was successfully deployed

1 active deployment
staging - public — 6db2b495 Deployed Oct 2, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants