mirror of
https://github.com/netbirdio/docs.git
synced 2026-08-26 17:51:27 +02:00
Restructure Troubleshooting into a hub with per-area pages (#814)
* Restructure Troubleshooting into a hub with per-area pages - Add a Troubleshooting hub (/help/troubleshooting) with icon/chip cards and a "Still stuck?" CTA - Split NetBird Client troubleshooting into an overview + per-OS pages (Linux, Windows, macOS, Android, iOS) - Split Self-hosted troubleshooting into an overview + per-area pages (installation, IdP, dashboard, certificates, connectivity, database) - Split "Report bugs and issues" into Community Support and NetBird Support pages - Add Troubleshooting resource connectivity and a NetBird Cloud pending-approval page - Add DNS troubleshooting Issue 8 (Windows NRPT rule blocked by a lingering GPO) - Cross-reference the new pages from networks, DNS, and reverse-proxy docs; update nav Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * Address review: client terminology, dead props, labels, cross-links - Use "client" instead of "agent" across the client troubleshooting pages (headings, prose, anchors) - Remove unused source: props from the Troubleshooting hub tiles - Relabel the "NetBird Cloud" grouping to "Cloud & identity" (SSO/provisioning also apply to self-hosted) - Add a Tiles title on the report-bug landing; add reverse-proxy -> resource-connectivity cross-link - Fix comma splices introduced by the em-dash cleanup in relayed-connections Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * Add client-side hash redirect for moved self-hosted anchors Old deep links like /selfhosted/troubleshooting#debugging-turn-connections now forward to the per-area page, since next.config redirects can't act on the URL fragment. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * Apply docs-skill review: conventions + reshape area pages - "open source" (no hyphen), expand NRPT on first use, descriptive alt text + captions on TURN images - Fix inherited "Netbird" casing in the client glossary - Reshape the six self-hosted area pages to Symptom -> likely causes (ordered) -> Fix -> Confirm, preserving anchored headings Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * Fix two typos in client glossary (CodeRabbit) - "nunning" -> "running" in the glossary - possessive "it's" -> "its" in the routing-table sentence Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * docs: fix two broken links in troubleshooting pages - database: point the "upgrade path" link at /selfhosted/maintenance/upgrade; selfhosted-quickstart has no #upgrade anchor so the old link landed at page top - client: add HashRedirect so old #net-bird-agent-status deep links forward to the renamed #net-bird-client-status section on the same page * docs: address review follow-ups (deep-link redirects + client casing) - self-hosted troubleshooting: extend the HashRedirect map with the per-issue (###-level) anchors from the old single page, so old deep links land on the exact sub-section of the new area page rather than just the page top - client glossary: lowercase "NetBird client" in the peer-a/peer-b entries (house convention) and fix "linux" -> "Linux" * docs: review polish — fix image class + first-use acronym glosses - connectivity: fix bad CSS class imagewrapper-nig -> imagewrapper on the TURN-test screenshot (the typo'd class matched no style and broke zoom) - gloss acronyms on first use: GPO (DNS Issue 8), IdP/SSO (identity-provider), ACME (certificates), CORS (dashboard) --------- Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com> Co-authored-by: Jack Carter <128555021+SunsetDrifter@users.noreply.github.com>
This commit is contained in:
Bruno Mercier Costa
committed by
GitHub
GitHub
parent
ffb72cfa34
commit
5729ad035e
@@ -736,7 +736,28 @@ export const docsNavigation = [
|
||||
],
|
||||
},
|
||||
{ title: 'Advanced Guide', href: '/selfhosted/selfhosted-guide' },
|
||||
{ title: 'Troubleshooting', href: '/selfhosted/troubleshooting' },
|
||||
{
|
||||
title: 'Troubleshooting',
|
||||
isOpen: false,
|
||||
links: [
|
||||
{ title: 'Overview', href: '/selfhosted/troubleshooting' },
|
||||
{ title: 'Installation', href: '/selfhosted/troubleshooting/installation' },
|
||||
{
|
||||
title: 'Embedded IdP',
|
||||
href: '/selfhosted/troubleshooting/identity-provider',
|
||||
},
|
||||
{ title: 'Dashboard', href: '/selfhosted/troubleshooting/dashboard' },
|
||||
{
|
||||
title: 'Certificates',
|
||||
href: '/selfhosted/troubleshooting/certificates',
|
||||
},
|
||||
{
|
||||
title: 'Connectivity',
|
||||
href: '/selfhosted/troubleshooting/connectivity',
|
||||
},
|
||||
{ title: 'Database', href: '/selfhosted/troubleshooting/database' },
|
||||
],
|
||||
},
|
||||
{
|
||||
title: 'Migration Guides',
|
||||
isOpen: false,
|
||||
@@ -856,14 +877,117 @@ export const docsNavigation = [
|
||||
title: 'GET MORE HELP',
|
||||
links: [
|
||||
{
|
||||
title: 'Troubleshooting client issues',
|
||||
href: '/help/troubleshooting-client',
|
||||
title: 'Troubleshooting',
|
||||
isOpen: false,
|
||||
links: [
|
||||
{ title: 'Overview', href: '/help/troubleshooting' },
|
||||
{
|
||||
title: 'NetBird Client',
|
||||
isOpen: false,
|
||||
links: [
|
||||
{ title: 'Overview', href: '/help/troubleshooting-client' },
|
||||
{ title: 'Linux', href: '/help/troubleshooting-client/linux' },
|
||||
{ title: 'Windows', href: '/help/troubleshooting-client/windows' },
|
||||
{ title: 'macOS', href: '/help/troubleshooting-client/macos' },
|
||||
{ title: 'Android', href: '/help/troubleshooting-client/android' },
|
||||
{ title: 'iOS', href: '/help/troubleshooting-client/ios' },
|
||||
],
|
||||
},
|
||||
{
|
||||
title: 'Self-hosted',
|
||||
isOpen: false,
|
||||
links: [
|
||||
{ title: 'Overview', href: '/selfhosted/troubleshooting' },
|
||||
{
|
||||
title: 'Installation',
|
||||
href: '/selfhosted/troubleshooting/installation',
|
||||
},
|
||||
{
|
||||
title: 'Embedded IdP',
|
||||
href: '/selfhosted/troubleshooting/identity-provider',
|
||||
},
|
||||
{
|
||||
title: 'Dashboard',
|
||||
href: '/selfhosted/troubleshooting/dashboard',
|
||||
},
|
||||
{
|
||||
title: 'Certificates',
|
||||
href: '/selfhosted/troubleshooting/certificates',
|
||||
},
|
||||
{
|
||||
title: 'Connectivity',
|
||||
href: '/selfhosted/troubleshooting/connectivity',
|
||||
},
|
||||
{
|
||||
title: 'Database',
|
||||
href: '/selfhosted/troubleshooting/database',
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
title: 'Cloud & identity',
|
||||
isOpen: false,
|
||||
links: [
|
||||
{
|
||||
title: 'Pending approval',
|
||||
href: '/help/troubleshooting-account-access',
|
||||
},
|
||||
{ title: 'IdP & SSO setup', href: '/manage/team/single-sign-on' },
|
||||
{ title: 'User provisioning', href: '/manage/team/idp-sync' },
|
||||
{
|
||||
title: 'Plan limits & quotas',
|
||||
href: '/manage/settings/plans-and-billing',
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
title: 'Connectivity',
|
||||
isOpen: false,
|
||||
links: [
|
||||
{
|
||||
title: 'Relayed Connections',
|
||||
href: '/help/troubleshooting-relayed-connections',
|
||||
},
|
||||
{
|
||||
title: 'Resource Connectivity',
|
||||
href: '/help/troubleshooting-resource-connectivity',
|
||||
},
|
||||
{
|
||||
title: 'NAT & Connectivity',
|
||||
href: '/about-netbird/understanding-nat-and-connectivity',
|
||||
},
|
||||
{
|
||||
title: 'Ports & Firewalls',
|
||||
href: '/about-netbird/ports-and-firewalls',
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
title: 'Access control',
|
||||
isOpen: false,
|
||||
links: [
|
||||
{ title: 'Policies', href: '/manage/access-control' },
|
||||
{
|
||||
title: 'Posture checks',
|
||||
href: '/manage/access-control/posture-checks',
|
||||
},
|
||||
{
|
||||
title: 'Groups',
|
||||
href: '/manage/access-control#understanding-groups',
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
title: 'Report a bug',
|
||||
isOpen: false,
|
||||
links: [
|
||||
{ title: 'Overview', href: '/help/report-bug-issues' },
|
||||
{ title: 'Community Support', href: '/help/community-support' },
|
||||
{ title: 'NetBird Support', href: '/help/netbird-support' },
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
title: 'Troubleshooting relayed connections',
|
||||
href: '/help/troubleshooting-relayed-connections',
|
||||
},
|
||||
{ title: 'Report bugs and issues', href: '/help/report-bug-issues' },
|
||||
{
|
||||
title: 'Support Matrix',
|
||||
isOpen: false,
|
||||
|
||||
Reference in New Issue
Block a user