sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-09-02 05:01:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: reorganize Use Cases navigation (#834)

Browse Source 
* docs: consolidate scenario guides under /use-cases with redirects

Move 11 pages: feature-nested use cases from manage/networks,
manage/network-routes, manage/reverse-proxy, and the Kubernetes
integration into /use-cases/remote-access, /use-cases/cloud, and
/use-cases/security; the site-to-site decision page becomes
/use-cases/remote-access; the MikroTik guide becomes an install
guide at /get-started/install/mikrotik.

Add one redirect per moved page and flatten existing redirect
chains so every legacy URL resolves in a single hop. The
deprecated Routes site-to-site recipe stays put.

* docs: rebuild sidebar navigation for use-cases reorg

Remove the four nested Use Cases sublists from Manage NetBird;
keep the deprecated Routes recipe as a direct 'Site-to-Site
(legacy)' link. Rebuild USE CASES with Remote Access, Cloud &
Kubernetes, Security groups and a flat Homelab link. Add MikroTik
to Get Started > Platforms.

* docs: rebuild use-case index pages and refresh feature landing links

Turn /use-cases into an "I want to..." scenario finder. Retitle
the site-to-site decision page to Remote Access and point its
links at the new sibling URLs. Add the Kubernetes service and
private-proxy guides to the cloud and security indexes, refresh
the homelab landing links, and update the Networks, Routes,
Reverse Proxy, and Kubernetes landing pages to the new use-case
URLs.

* docs: update internal links to new use-case URLs

Point cross-links across the docs at the consolidated
/use-cases URLs. Links to the deprecated Routes site-to-site
recipe and all image paths under public/docs-static are left
unchanged.

* docs: shorten sidebar label to Site-to-Site

* docs: move Kubernetes into its own Use Cases section

Pull the entire Kubernetes integration out of Manage > Integrations
into a dedicated Kubernetes group under Use Cases at /use-cases/
kubernetes, and move the two Kubernetes cloud guides there too.
Rename the Cloud group (was 'Cloud & Kubernetes'); Integrations
keeps the MDM deployment pages. Add redirects for every moved page
and flatten existing chains.

* docs: drop 'NetBird on' prefix from cloud sidebar labels

* docs: alphabetize Remote Access use cases in sidebar

* ❯ add mikrotik to install index

* docs: fix duplicated word in remote-access link label on TV install pages

---------

Co-authored-by: Brandon Hopkins <brandon@techhut.tv>
This commit is contained in:
Jack Carter
2026-07-08 10:20:12 +02:00
committed by GitHub
parent 8ae475c29c
commit 8824f4af97
38 changed files with 384 additions and 264 deletions
Download Patch File Download Diff File Expand all files Collapse all files

195
src/components/NavigationDocs.jsx
View File

@@ -71,6 +71,7 @@ export const docsNavigation = [
{ title: 'pfSense', href: '/get-started/install/pfsense' },
{ title: 'OPNsense', href: '/get-started/install/opnsense' },
{ title: 'OpenWrt', href: '/get-started/install/openwrt' },
{ title: 'MikroTik', href: '/get-started/install/mikrotik' },
{ title: 'Raspberry Pi', href: '/get-started/install/raspberrypi' },
],
},
@@ -203,36 +204,6 @@ export const docsNavigation = [
title: 'Masquerade',
href: '/manage/networks/masquerade',
},
{
title: 'Use Cases',
isOpen: false,
links: [
{
title: 'Access Home Devices',
href: '/manage/networks/use-cases/access-home-devices',
},
{
title: 'Cloud to On-Premise',
href: '/manage/networks/use-cases/cloud-to-on-premise',
},
{
title: 'Site-to-VPN',
href: '/manage/networks/use-cases/site-to-vpn',
},
{
title: 'Site-to-Site',
href: '/manage/networks/use-cases/site-to-site',
},
{
title: 'Reach Services on the Routing Peer',
href: '/manage/networks/use-cases/reach-services-on-the-routing-peer',
},
{
title: 'Active Directory & Windows File Shares',
href: '/manage/networks/use-cases/active-directory',
},
],
},
],
},
{
@@ -241,18 +212,8 @@ export const docsNavigation = [
links: [
{ title: 'Overview', href: '/manage/network-routes' },
{
title: 'Use Cases',
isOpen: false,
links: [
{
title: 'Site-to-Site',
href: '/manage/network-routes/use-cases/site-to-site',
},
{
title: 'Exit Nodes',
href: '/manage/network-routes/use-cases/exit-nodes',
},
],
title: 'Site-to-Site (legacy)',
href: '/manage/network-routes/use-cases/site-to-site',
},
{
title: 'Access Control',
@@ -298,16 +259,6 @@ export const docsNavigation = [
title: 'Troubleshooting',
href: '/manage/reverse-proxy/troubleshooting',
},
{
title: 'Use Cases',
isOpen: false,
links: [
{
title: 'No Public Inbound',
href: '/manage/reverse-proxy/use-cases/private-no-inbound',
},
],
},
],
},
{
@@ -489,42 +440,6 @@ export const docsNavigation = [
},
],
},
{
title: 'Kubernetes',
isOpen: true,
links: [
{
title: 'Getting Started',
href: '/manage/integrations/kubernetes',
},
{
title: 'Routing Peer',
href: '/manage/integrations/kubernetes/routing-peer',
},
{
title: 'Client Sidecar',
href: '/manage/integrations/kubernetes/client-sidecar',
},
{
title: 'API Server Proxy',
href: '/manage/integrations/kubernetes/api-server-proxy',
},
{
title: 'Gateway API',
href: '/manage/integrations/kubernetes/gateway-api',
},
{
title: 'Use Cases',
isOpen: false,
links: [
{
title: 'Route to a Kubernetes Service',
href: '/manage/integrations/kubernetes/use-cases/route-to-a-kubernetes-service',
},
],
},
],
},
],
},
@@ -600,10 +515,16 @@ export const docsNavigation = [
title: 'Integrations',
href: '/agent-network/integrations',
links: [
{ title: 'Claude Code', href: '/agent-network/integrations/claude-code' },
{
title: 'Claude Code',
href: '/agent-network/integrations/claude-code',
},
{ title: 'Codex', href: '/agent-network/integrations/codex' },
{ title: 'LiteLLM', href: '/agent-network/integrations/litellm' },
{ title: 'Google Vertex AI', href: '/agent-network/integrations/vertex-ai' },
{
title: 'Google Vertex AI',
href: '/agent-network/integrations/vertex-ai',
},
{ title: 'AWS Bedrock', href: '/agent-network/integrations/bedrock' },
],
},
@@ -822,7 +743,10 @@ export const docsNavigation = [
isOpen: false,
links: [
{ title: 'Overview', href: '/selfhosted/troubleshooting' },
{ title: 'Installation', href: '/selfhosted/troubleshooting/installation' },
{
title: 'Installation',
href: '/selfhosted/troubleshooting/installation',
},
{
title: 'Embedded IdP',
href: '/selfhosted/troubleshooting/identity-provider',
@@ -905,16 +829,35 @@ export const docsNavigation = [
{
title: 'Remote Access',
isOpen: false,
links: [{ title: 'Overview', href: '/use-cases/site-to-site' }],
},
{
title: 'Homelab',
isOpen: false,
links: [
{ title: 'Overview', href: '/use-cases/homelab' },
{ title: 'Overview', href: '/use-cases/remote-access' },
{
title: 'NetBird on MikroTik Router',
href: '/use-cases/homelab/client-on-mikrotik-router',
title: 'Access Home Devices',
href: '/use-cases/remote-access/access-home-devices',
},
{
title: 'Active Directory & Windows File Shares',
href: '/use-cases/remote-access/active-directory',
},
{
title: 'Cloud to On-Premise',
href: '/use-cases/remote-access/cloud-to-on-premise',
},
{
title: 'Exit Nodes',
href: '/use-cases/remote-access/exit-nodes',
},
{
title: 'Reach Services on the Routing Peer',
href: '/use-cases/remote-access/reach-services-on-the-routing-peer',
},
{
title: 'Site-to-Site',
href: '/use-cases/remote-access/site-to-site',
},
{
title: 'Site-to-VPN',
href: '/use-cases/remote-access/site-to-vpn',
},
],
},
@@ -924,23 +867,50 @@ export const docsNavigation = [
links: [
{ title: 'Overview', href: '/use-cases/cloud' },
{
title: 'NetBird on AWS ECS',
title: 'AWS ECS',
href: '/use-cases/cloud/aws-ecs-terraform',
},
{
title: 'NetBird on Serverless (FaaS)',
title: 'Serverless (FaaS)',
href: '/use-cases/cloud/netbird-on-faas',
},
{
title: 'Routing Peers and Kubernetes',
href: '/use-cases/cloud/routing-peers-and-kubernetes',
},
{
title: 'Distributed Multi-Cloud AI',
href: '/use-cases/cloud/distributed-multi-cloud-ai',
},
],
},
{
title: 'Kubernetes',
isOpen: false,
links: [
{ title: 'Getting Started', href: '/use-cases/kubernetes' },
{
title: 'Routing Peer',
href: '/use-cases/kubernetes/routing-peer',
},
{
title: 'Client Sidecar',
href: '/use-cases/kubernetes/client-sidecar',
},
{
title: 'API Server Proxy',
href: '/use-cases/kubernetes/api-server-proxy',
},
{
title: 'Gateway API',
href: '/use-cases/kubernetes/gateway-api',
},
{
title: 'Route to a Kubernetes Service',
href: '/use-cases/kubernetes/route-to-a-kubernetes-service',
},
{
title: 'Deploy Routing Peers to a Cluster',
href: '/use-cases/kubernetes/routing-peers-and-kubernetes',
},
],
},
{
title: 'Security',
isOpen: false,
@@ -950,8 +920,13 @@ export const docsNavigation = [
title: 'Implement Zero Trust',
href: '/use-cases/security/implement-zero-trust',
},
{
title: 'Private Proxy Without Inbound Ports',
href: '/use-cases/security/private-no-inbound',
},
],
},
{ title: 'Homelab', href: '/use-cases/homelab' },
],
},
{
@@ -968,9 +943,15 @@ export const docsNavigation = [
links: [
{ title: 'Overview', href: '/help/troubleshooting-client' },
{ title: 'Linux', href: '/help/troubleshooting-client/linux' },
{ title: 'Windows', href: '/help/troubleshooting-client/windows' },
{
title: 'Windows',
href: '/help/troubleshooting-client/windows',
},
{ title: 'macOS', href: '/help/troubleshooting-client/macos' },
{ title: 'Android', href: '/help/troubleshooting-client/android' },
{
title: 'Android',
href: '/help/troubleshooting-client/android',
},
{ title: 'iOS', href: '/help/troubleshooting-client/ios' },
],
},