docs: reorganize Use Cases navigation (#834)

* 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
co-authored by Brandon Hopkins
parent 8ae475c29c
commit 8824f4af97
38 changed files with 384 additions and 264 deletions
+109 -18
View File
@@ -38,7 +38,7 @@ const nextConfig = {
},
{
source: '/manage/network-routes/use-cases/by-scenario/site-to-vpn',
destination: '/manage/networks/use-cases/site-to-vpn',
destination: '/use-cases/remote-access/site-to-vpn',
permanent: true,
},
{
@@ -283,12 +283,12 @@ const nextConfig = {
},
{
source: '/how-to/routing-peers-and-kubernetes',
destination: '/use-cases/cloud/routing-peers-and-kubernetes',
destination: '/use-cases/kubernetes/routing-peers-and-kubernetes',
permanent: true,
},
{
source: '/how-to/client-on-mikrotik-router',
destination: '/use-cases/homelab/client-on-mikrotik-router',
destination: '/get-started/install/mikrotik',
permanent: true,
},
{
@@ -319,7 +319,7 @@ const nextConfig = {
},
{
source: '/how-to/access-home-network',
destination: '/manage/networks/use-cases/access-home-devices',
destination: '/use-cases/remote-access/access-home-devices',
permanent: true,
},
// documentation redirects for network-routes
@@ -330,7 +330,7 @@ const nextConfig = {
},
{
source: '/how-to/configuring-default-routes-for-internet-traffic',
destination: '/manage/network-routes/use-cases/exit-nodes',
destination: '/use-cases/remote-access/exit-nodes',
permanent: true,
},
{
@@ -499,7 +499,7 @@ const nextConfig = {
},
{
source: '/how-to/kubernetes-operator',
destination: '/manage/integrations/kubernetes',
destination: '/use-cases/kubernetes',
permanent: true,
},
// documentation redirects for public-api
@@ -551,10 +551,101 @@ const nextConfig = {
destination: '/manage/dns/custom-zones',
permanent: true,
},
// Use cases reorg: scenario guides consolidated under /use-cases
{
source: '/manage/integrations/kubernetes',
destination: '/use-cases/kubernetes',
permanent: true,
},
{
source: '/manage/integrations/kubernetes/routing-peer',
destination: '/use-cases/kubernetes/routing-peer',
permanent: true,
},
{
source: '/manage/integrations/kubernetes/client-sidecar',
destination: '/use-cases/kubernetes/client-sidecar',
permanent: true,
},
{
source: '/manage/integrations/kubernetes/api-server-proxy',
destination: '/use-cases/kubernetes/api-server-proxy',
permanent: true,
},
{
source: '/manage/integrations/kubernetes/gateway-api',
destination: '/use-cases/kubernetes/gateway-api',
permanent: true,
},
{
source: '/use-cases/cloud/route-to-a-kubernetes-service',
destination: '/use-cases/kubernetes/route-to-a-kubernetes-service',
permanent: true,
},
{
source: '/use-cases/cloud/routing-peers-and-kubernetes',
destination: '/use-cases/kubernetes/routing-peers-and-kubernetes',
permanent: true,
},
{
source: '/use-cases/site-to-site',
destination: '/use-cases/remote-access',
permanent: true,
},
{
source: '/manage/networks/use-cases/site-to-site',
destination: '/use-cases/remote-access/site-to-site',
permanent: true,
},
{
source: '/manage/networks/use-cases/site-to-vpn',
destination: '/use-cases/remote-access/site-to-vpn',
permanent: true,
},
{
source: '/manage/networks/use-cases/cloud-to-on-premise',
destination: '/use-cases/remote-access/cloud-to-on-premise',
permanent: true,
},
{
source: '/manage/networks/use-cases/access-home-devices',
destination: '/use-cases/remote-access/access-home-devices',
permanent: true,
},
{
source: '/manage/networks/use-cases/reach-services-on-the-routing-peer',
destination: '/use-cases/remote-access/reach-services-on-the-routing-peer',
permanent: true,
},
{
source: '/manage/networks/use-cases/active-directory',
destination: '/use-cases/remote-access/active-directory',
permanent: true,
},
{
source: '/manage/network-routes/use-cases/exit-nodes',
destination: '/use-cases/remote-access/exit-nodes',
permanent: true,
},
{
source: '/manage/integrations/kubernetes/use-cases/route-to-a-kubernetes-service',
destination: '/use-cases/kubernetes/route-to-a-kubernetes-service',
permanent: true,
},
{
source: '/manage/reverse-proxy/use-cases/private-no-inbound',
destination: '/use-cases/security/private-no-inbound',
permanent: true,
},
{
source: '/use-cases/homelab/client-on-mikrotik-router',
destination: '/get-started/install/mikrotik',
permanent: true,
},
// Site-to-site documentation restructure redirects
{
source: '/use-cases/setup-site-to-site-access',
destination: '/use-cases/site-to-site',
destination: '/use-cases/remote-access',
permanent: true,
},
{
@@ -569,17 +660,17 @@ const nextConfig = {
},
{
source: '/manage/networks/homelab/access-home-network',
destination: '/manage/networks/use-cases/access-home-devices',
destination: '/use-cases/remote-access/access-home-devices',
permanent: true,
},
{
source: '/manage/networks/use-cases/by-scenario/access-home-devices',
destination: '/manage/networks/use-cases/access-home-devices',
destination: '/use-cases/remote-access/access-home-devices',
permanent: true,
},
{
source: '/manage/networks/use-cases/by-scenario/cloud-to-on-premise',
destination: '/manage/networks/use-cases/cloud-to-on-premise',
destination: '/use-cases/remote-access/cloud-to-on-premise',
permanent: true,
},
// Networks guides moved to use-cases
@@ -636,7 +727,7 @@ const nextConfig = {
},
{
source: '/manage/network-routes/configuring-default-routes-for-internet-traffic',
destination: '/manage/network-routes/use-cases/exit-nodes',
destination: '/use-cases/remote-access/exit-nodes',
permanent: true,
},
{
@@ -671,7 +762,7 @@ const nextConfig = {
},
{
source: '/manage/network-routes/use-cases/by-scenario/exit-nodes',
destination: '/manage/network-routes/use-cases/exit-nodes',
destination: '/use-cases/remote-access/exit-nodes',
permanent: true,
},
{
@@ -692,22 +783,22 @@ const nextConfig = {
// Site-to-Site section redirects (overview and comprehensive guides)
{
source: '/manage/site-to-site',
destination: '/use-cases/site-to-site',
destination: '/use-cases/remote-access',
permanent: true,
},
{
source: '/manage/site-to-site/connect-home-networks',
destination: '/use-cases/site-to-site',
destination: '/use-cases/remote-access',
permanent: true,
},
{
source: '/manage/site-to-site/connect-office-networks',
destination: '/use-cases/site-to-site',
destination: '/use-cases/remote-access',
permanent: true,
},
{
source: '/manage/site-to-site/connect-cloud-environments',
destination: '/use-cases/site-to-site',
destination: '/use-cases/remote-access',
permanent: true,
},
{
@@ -728,7 +819,7 @@ const nextConfig = {
},
{
source: '/use-cases/routing-peers-and-kubernetes',
destination: '/use-cases/cloud/routing-peers-and-kubernetes',
destination: '/use-cases/kubernetes/routing-peers-and-kubernetes',
permanent: true,
},
{
@@ -738,7 +829,7 @@ const nextConfig = {
},
{
source: '/use-cases/client-on-mikrotik-router',
destination: '/use-cases/homelab/client-on-mikrotik-router',
destination: '/get-started/install/mikrotik',
permanent: true,
},
{