docs: add Support Matrix section under Get More Help by emrcbrn · Pull Request #764 · netbirdio/docs

emrcbrn · 2026-05-21T14:23:53Z

Summary

Adds a new Support Matrix section under Get More Help so users have an authoritative place to check what NetBird supports on each platform.

The section lives at /help/support-matrix/ with:

An overview introducing the matrix and linking out to each component.
NetBird Client — launchpad + per-OS-family pages (Linux, Windows, macOS, iOS, Android, Android TV, tvOS), mirroring the src/pages/get-started/install/ layout.
Kubernetes Operator — policy-style page explaining the version-window approach (no tables yet; phrasing inspired by spegel's dependency compatibility docs).
Terraform Provider and Self-Hosted — TBD stubs for the team to fill in.

Structure

src/pages/help/support-matrix/
├── index.mdx                          → Tiles to each component
├── netbird-client/
│   ├── index.mdx                      → Tiles to each OS + Go toolchain table
│   ├── linux.mdx
│   ├── windows.mdx
│   ├── macos.mdx
│   ├── ios.mdx
│   ├── android.mdx
│   ├── android-tv.mdx
│   └── tvos.mdx
├── kubernetes-operator.mdx
├── terraform-provider.mdx
└── self-hosted.mdx

src/components/NavigationDocs.jsx adds a nested Support Matrix entry to the GET MORE HELP group; NetBird Client is a sub-group with the seven OS pages as leaves (same 3-deep pattern as Access Control → Posture Checks → leaf).

Pre-filled data

The Go toolchain table on the NetBird Client launchpad is authoritative — sourced from go.mod at each release tag:

NetBird client version	Go version
v0.20.0 – v0.25.3	1.20
v0.25.4 – v0.29.1	1.21
v0.29.2 – v0.60.2	1.23
v0.60.3 – v0.62.3	1.24
v0.63.0 – current	1.25

Linux / Windows / macOS pages pre-fill OS version cutoffs derived from Go's minimum OS requirements at each release's Go version. Each of those three pages opens with a Warning callout marking the cutoffs as inferences pending team confirmation — NetBird may have stricter requirements than Go. The Windows 7/8 cutoff at v0.25.3 matches the existing data point.

iOS / Android / Android TV / tvOS pages and the Kubernetes operator / Terraform provider / Self-Hosted pages remain TBD placeholders — Go's reference doesn't map cleanly to gomobile / SDK constraints, and the rest are awaiting team input.

Design choices

Launchpads use <Tiles> (same as use-cases/cloud/index.mdx) for navigation. Version data lives on the detail page only, so a tile description never tries to summarize an arbitrarily large per-distro table.
Each detail page has 2+ ## sections so the right-side "On this page" TOC populates.
New platforms scale: drop a new MDX into the matching directory, append one nav links entry.

Test plan

npm run build passes; all 12 new routes prerender as static HTML.
Verify sidebar nesting renders (Support Matrix → NetBird Client → OS pages).
Verify "On this page" right-side TOC populates on each detail page.
Confirm with the team the derived OS cutoffs on Linux / Windows / macOS, then either remove the Warning callouts or refine the values.
Fill TBD entries on the mobile/TV pages, Kubernetes operator tables, Terraform provider, and self-hosted page.

Screenshots

Support Matrix overview

Sidebar nesting (GET MORE HELP → Support Matrix → NetBird Client)

NetBird Client launchpad

Windows — derived data with Warning callout

macOS — derived data with Warning callout

Linux — kernel floor (derived) + distros (TBD)

🤖 Generated with Claude Code

Summary by CodeRabbit

New Features
- Introduced a comprehensive Support Matrix documentation hub providing version compatibility information for NetBird Client across all platforms (Linux, Windows, macOS, iOS, Android, Android TV, tvOS), along with detailed support information for Kubernetes Operator, Terraform Provider, and Self-Hosted deployments. Includes guidance on reporting compatibility issues and understanding support status.

Adds /help/support-matrix with an overview, NetBird client (split into per-OS pages following the get-started/install layout), Kubernetes operator, Terraform provider, and self-hosted sub-sections. Linux/Windows/macOS pages pre-fill OS version cutoffs derived from the Go toolchain's minimum OS requirements at each NetBird release's Go version (sourced from go.mod at release tags). Each derived page carries a Warning callout marking the values as inferences pending team confirmation. Mobile/TV pages and the other component pages remain TBD placeholders. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

coderabbitai · 2026-05-21T14:24:19Z

Warning

Rate limit exceeded

@emrcbrn has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 43 minutes and 25 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 04ac011b-162e-412e-ba12-ba5352e5a713

📥 Commits

Reviewing files that changed from the base of the PR and between 21c24bf and d87523d.

📒 Files selected for processing (1)

src/pages/help/support-matrix/netbird-client/linux.mdx

📝 Walkthrough

Walkthrough

This PR introduces the NetBird Support Matrix documentation feature, adding a navigation entry, a landing page with tiles, client platform support pages (Linux, Windows, macOS, iOS, Android variants, tvOS), and infrastructure compatibility pages for Kubernetes Operator, Terraform Provider, and Self‑Hosted deployments.

Changes

Support Matrix Documentation

Layer / File(s)	Summary
Navigation and overview landing page `src/components/NavigationDocs.jsx`, `src/pages/help/support-matrix/index.mdx`	Navigation menu updated with a "Support Matrix" link group; landing page created with tiles linking to NetBird Client, Kubernetes Operator, Terraform Provider, and Self‑Hosted, plus guidance on interpreting support status labels.
NetBird Client support matrices for all platforms `src/pages/help/support-matrix/netbird-client/index.mdx`, `src/pages/help/support-matrix/netbird-client/linux.mdx`, `src/pages/help/support-matrix/netbird-client/windows.mdx`, `src/pages/help/support-matrix/netbird-client/macos.mdx`, `src/pages/help/support-matrix/netbird-client/ios.mdx`, `src/pages/help/support-matrix/netbird-client/android.mdx`, `src/pages/help/support-matrix/netbird-client/android-tv.mdx`, `src/pages/help/support-matrix/netbird-client/tvos.mdx`	Client hub page with OS tiles and Go toolchain mapping; platform pages added documenting supported versions, architectures, and reporting instructions, with several tables containing TBD placeholders.
Infrastructure and integration support matrices `src/pages/help/support-matrix/kubernetes-operator.mdx`, `src/pages/help/support-matrix/terraform-provider.mdx`, `src/pages/help/support-matrix/self-hosted.mdx`	Support matrices for Kubernetes Operator, Terraform Provider, and Self‑Hosted deployments detailing compatibility scopes, placeholder tables, and instructions for reporting compatibility issues.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested reviewers

braginini
SunsetDrifter

Poem

🐰 In docs I hopped to build a chart,
Rows of platforms, each a part,
From Linux kernels to tvOS light,
Kubernetes and Terraform in sight,
NetBird’s support blooms — a rabbit’s delight.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and accurately describes the main change: adding a new Support Matrix section under Get More Help in the documentation navigation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Drops the per-distro TBD table and consolidates the description with the Warning callout. Splits Linux support by client mode: userspace follows the Go toolchain's minimum OS requirements; kernel mode depends on the host's iptables/nftables features. Notes Ubuntu 20.04 as the end-to-end test floor. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Replaces the single Ubuntu 20.04 floor reference with the full set of distributions covered by the NetBird team's end-to-end tests: Ubuntu 20.04/22.04/24.04, Debian 12, Rocky Linux 9, and Fedora 41. Ubuntu 20.04 remains called out as the oldest tested release. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

mlsmaycon approved these changes May 22, 2026

View reviewed changes

emrcbrn and others added 2 commits May 22, 2026 10:59

emrcbrn merged commit a28e476 into netbirdio:main May 22, 2026
3 checks passed

emrcbrn deleted the docs/support-matrix branch May 22, 2026 09:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add Support Matrix section under Get More Help#764

docs: add Support Matrix section under Get More Help#764
emrcbrn merged 3 commits into
netbirdio:mainfrom
emrcbrn:docs/support-matrix

emrcbrn commented May 21, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented May 21, 2026 •

edited

Loading

Rate limit exceeded

Walkthrough

Changes

Estimated code review effort

Suggested reviewers

Poem

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

emrcbrn commented May 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Structure

Pre-filled data

Design choices

Test plan

Screenshots

Support Matrix overview

Sidebar nesting (GET MORE HELP → Support Matrix → NetBird Client)

NetBird Client launchpad

Windows — derived data with Warning callout

macOS — derived data with Warning callout

Linux — kernel floor (derived) + distros (TBD)

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented May 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rate limit exceeded

Walkthrough

Changes

Estimated code review effort

Suggested reviewers

Poem

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

emrcbrn commented May 21, 2026 •

edited

Loading

coderabbitai Bot commented May 21, 2026 •

edited

Loading