mirror of
https://github.com/netbirdio/docs.git
synced 2026-04-22 18:36:36 +00:00
change docs layour
This commit is contained in:
Julia
@@ -1,10 +1,10 @@
|
|||||||
import { useRouter } from 'next/router'
|
import { useRouter } from 'next/router'
|
||||||
import clsx from 'clsx'
|
import clsx from 'clsx'
|
||||||
import {
|
import {
|
||||||
ActivePageMarker,
|
ActivePageMarker,
|
||||||
NavLink,
|
NavLink,
|
||||||
TopLevelNavItem,
|
TopLevelNavItem,
|
||||||
VisibleSectionHighlight
|
VisibleSectionHighlight
|
||||||
} from "@/components/NavigationAPI";
|
} from "@/components/NavigationAPI";
|
||||||
import {AnimatePresence, motion} from "framer-motion";
|
import {AnimatePresence, motion} from "framer-motion";
|
||||||
import {Button} from "@/components/mdx";
|
import {Button} from "@/components/mdx";
|
||||||
@@ -12,197 +12,279 @@ import {useState} from "react";
|
|||||||
import {NavigationStateProvider, useNavigationState} from "@/components/NavigationState";
|
import {NavigationStateProvider, useNavigationState} from "@/components/NavigationState";
|
||||||
import ChevronDownIcon from "@/components/icons/ChevronDownIcon";
|
import ChevronDownIcon from "@/components/icons/ChevronDownIcon";
|
||||||
|
|
||||||
|
|
||||||
export const docsNavigation = [
|
export const docsNavigation = [
|
||||||
{
|
{
|
||||||
title: 'About NetBird',
|
title: 'ABOUT',
|
||||||
links: [
|
links: [
|
||||||
{ title: 'Why WireGuard with NetBird?', href: '/about-netbird/why-wireguard-with-netbird' },
|
{ title: 'Introduction', href: 'introduction' },
|
||||||
{ title: 'How NetBird works', href: '/about-netbird/how-netbird-works' },
|
{ title: 'How NetBird works', href: '/about-netbird/how-netbird-works'},
|
||||||
{ title: 'NetBird vs. traditional VPN', href: '/about-netbird/netbird-vs-traditional-vpn' },
|
{ title: 'NetBird vs. traditional VPN', href: '/about-netbird/netbird-vs-traditional-vpn' },
|
||||||
{ title: 'Other', href: '/about-netbird/other' },
|
{ title: 'Why WireGuard with NetBird', href: '/about-netbird/why-wireguard-with-netbird' },
|
||||||
{ title: 'FAQ', href: '/about-netbird/faq' },
|
{ title: 'FAQ', href: '/about-netbird/faq' },
|
||||||
],
|
/*{ title: 'Whats new in version xx', href: '/welcome/how-netbird-works' },
|
||||||
},
|
{ title: 'Release notes', href: '/about-netbird/netbird-vs-traditional-vpn' },*/
|
||||||
{
|
|
||||||
title: 'How-to guides',
|
],
|
||||||
links: [
|
},
|
||||||
{ title: 'Getting started', href: '/how-to/getting-started' },
|
{
|
||||||
{ title: 'Installation', href: '/how-to/installation'},
|
title: 'GETTING STARTED',
|
||||||
/*{
|
links: [
|
||||||
title: 'Nested Nav Item',
|
{ title: 'Quickstart Guide', href: '/how-to/getting-started' },
|
||||||
isOpen: true,
|
{title: 'Install NetBird', href: '/how-to/installation' },
|
||||||
links: [
|
|
||||||
{ title: 'Quickstart guide', href: '/selfhosted/selfhosted-quickstart' },
|
|
||||||
{ title: 'Advanced guide', href: '/selfhosted/selfhosted-guide' },
|
/* { title: 'Update NetBird', href: '/how-to/enforce-periodic-user-authentication' },*/
|
||||||
{ title: 'Management SQLite Store', href: '/selfhosted/sqlite-store'},
|
|
||||||
{
|
|
||||||
title: 'Deeply Nested Nav Item',
|
],
|
||||||
links: [
|
},
|
||||||
{ title: 'NetBird vs. traditional VPN', href: '/about-netbird/netbird-vs-traditional-vpn' },
|
{
|
||||||
{ title: 'Other', href: '/about-netbird/other' },
|
title: 'MANAGE NETBIRD',
|
||||||
{ title: 'FAQ', href: '/about-netbird/faq' },
|
links: [
|
||||||
]
|
{
|
||||||
},
|
title: 'Peers',
|
||||||
]
|
isOpen: true,
|
||||||
},*/
|
links: [
|
||||||
{ title: 'Add machines to your network', href: '/how-to/add-machines-to-your-network' },
|
{ title: 'Add peers to your network', href: '/how-to/add-machines-to-your-network' },
|
||||||
{ title: 'Approve peers', href: '/how-to/approve-peers' },
|
{ title: 'Approve peers', href: '/how-to/approve-peers' },
|
||||||
{ title: 'Add users to your network', href: '/how-to/add-users-to-your-network' },
|
{ title: 'Setup keys', href: '/how-to/register-machines-using-setup-keys' },
|
||||||
{ title: 'Use setup keys for automation', href: '/how-to/register-machines-using-setup-keys' },
|
]
|
||||||
{ title: 'Manage network access', href: '/how-to/manage-network-access' },
|
},
|
||||||
{ title: 'Enforce periodic authentication', href: '/how-to/enforce-periodic-user-authentication' },
|
{
|
||||||
{ title: 'Enable post-quantum cryptography', href: '/how-to/enable-post-quantum-cryptography' },
|
title: 'Access Control',
|
||||||
{ title: 'Route traffic to private networks', href: '/how-to/routing-traffic-to-private-networks' },
|
isOpen: true,
|
||||||
{ title: 'Manage DNS in your network', href: '/how-to/manage-dns-in-your-network' },
|
links: [
|
||||||
{ title: 'Monitor system and network activity', href: '/how-to/monitor-system-and-network-activity' },
|
{ title: 'Manage Network Access', href: '/how-to/manage-network-access' },
|
||||||
{ title: 'Activity event streaming', href: '/how-to/activity-event-streaming' },
|
{ title: 'Posture Checks', href: '/how-to/manage-network-access' },
|
||||||
{ title: 'Access NetBird API', href: '/how-to/access-netbird-public-api' },
|
]
|
||||||
{ title: 'Running NetBird on FaaS', href: '/how-to/netbird-on-faas' },
|
},
|
||||||
{ title: 'Delete your NetBird account', href: '/how-to/delete-account' },
|
{
|
||||||
{ title: 'Manage access with posture checks', href: '/how-to/manage-posture-checks' },
|
title: 'Network Routes',
|
||||||
{ title: 'Deploy routing peers to Kubernetes', href: '/how-to/routing-peers-and-kubernetes' },
|
isOpen: true,
|
||||||
{ title: 'Report bugs and issues', href: '/how-to/report-bug-issues' },
|
links: [
|
||||||
{ title: 'Troubleshooting client issues', href: '/how-to/troubleshooting-client' },
|
{ title: 'Routing traffic to private networks', href: '/how-to/routing-traffic-to-private-networks' },
|
||||||
{ title: 'Examples', href: '/how-to/examples' },
|
|
||||||
{ title: 'CLI', href: '/how-to/cli' },
|
]
|
||||||
{ title: 'IdP sync', href: '/how-to/idp-sync' },
|
},
|
||||||
],
|
{
|
||||||
},
|
title: 'DNS',
|
||||||
{
|
isOpen: true,
|
||||||
title: 'Self-hosting NetBird',
|
links: [
|
||||||
links: [
|
{ title: 'Manage DNS in your network', href: 'how-to/manage-dns-in-your-network' },
|
||||||
{ title: 'Quickstart guide', href: '/selfhosted/selfhosted-quickstart' },
|
]
|
||||||
{ title: 'Advanced guide', href: '/selfhosted/selfhosted-guide' },
|
},
|
||||||
{ title: 'Management SQLite Store', href: '/selfhosted/sqlite-store'},
|
{
|
||||||
{ title: 'Supported IdPs', href: '/selfhosted/identity-providers' },
|
title: 'Team',
|
||||||
{ title: 'Management Geolocation', href: '/selfhosted/geo-support' },
|
isOpen: true,
|
||||||
{ title: 'Troubleshooting', href: '/selfhosted/troubleshooting' },
|
links: [
|
||||||
],
|
{ title: 'Add users to your network', href: '/how-to/add-users-to-your-network' },
|
||||||
},
|
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: 'Activity',
|
||||||
|
links: [
|
||||||
|
{ title: 'Activity Events', href: '/how-to/monitor-system-and-network-activity' },
|
||||||
|
{ title: 'Activity Event Streaming', href: '/how-to/activity-event-streaming' },
|
||||||
|
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: 'Settings',
|
||||||
|
isOpen: true,
|
||||||
|
links: [
|
||||||
|
{title: 'Authentication', href: '/how-to/enforce-periodic-user-authentication' },
|
||||||
|
/*{title: 'Groups', href: '/about-netbird/netbird-vs-traditional-vpn' },
|
||||||
|
{title: 'Plans & Billing', href: '/about-netbird/netbird-vs-traditional-vpn' },
|
||||||
|
{title: 'Delete Accounts/Danger Zone', href: '/how-to/delete-accounts' },*/
|
||||||
|
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: 'Integrations',
|
||||||
|
isOpen: true,
|
||||||
|
links: [
|
||||||
|
{title: 'Activity Event Streaming', href: '/how-to/activity-event-streaming' },
|
||||||
|
{title: 'Identity Provider', href: '/how-to/idp-sync' },
|
||||||
|
{title: 'Enable Post Quantum Cryptography', href: '/how-to/enable-post-quantum-cryptography' },
|
||||||
|
|
||||||
|
]
|
||||||
|
},
|
||||||
|
],
|
||||||
|
|
||||||
|
},
|
||||||
|
|
||||||
|
{
|
||||||
|
title: 'USE CASES',
|
||||||
|
links: [
|
||||||
|
{ title: 'NetBird on FaaS', href: '/how-to/netbird-on-faas' },
|
||||||
|
{ title: 'Routing peers and Kubernetes', href: '/how-to/routing-peers-and-kubernetes'},
|
||||||
|
{ title: 'NetBird Client on AWS ECS', href: '/how-to/examples'},
|
||||||
|
],
|
||||||
|
|
||||||
|
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: 'SELF-HOSTED NETBIRD',
|
||||||
|
links: [
|
||||||
|
{ title: 'Quickstart guide', href: '/selfhosted/selfhosted-quickstart' },
|
||||||
|
{ title: 'Advanced guide', href: '/selfhosted/selfhosted-guide' },
|
||||||
|
{ title: 'Management SQLite Store', href: '/selfhosted/sqlite-store'},
|
||||||
|
{ title: 'Supported IdPs', href: '/selfhosted/identity-providers' },
|
||||||
|
],
|
||||||
|
|
||||||
|
|
||||||
|
},
|
||||||
|
|
||||||
|
{
|
||||||
|
title: 'GET MORE HELP',
|
||||||
|
links: [
|
||||||
|
{ title: 'Troubleshooting client issues', href: '/how-to/troubleshooting-client' },
|
||||||
|
{ title: 'Report bug issues', href: '/how-to/report-bug-issues' },
|
||||||
|
|
||||||
|
],
|
||||||
|
|
||||||
|
|
||||||
|
},
|
||||||
|
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
export function NavigationDocs({className}) {
|
export function NavigationDocs({className}) {
|
||||||
return (
|
return (
|
||||||
<nav className={className}>
|
<nav className={className}>
|
||||||
<ul role="list">
|
<ul role="list">
|
||||||
<TopLevelNavItem href="https://netbird.io/">Home</TopLevelNavItem>
|
<TopLevelNavItem href="https://netbird.io/">Home</TopLevelNavItem>
|
||||||
<TopLevelNavItem href="/">Docs</TopLevelNavItem>
|
<TopLevelNavItem href="/">Docs</TopLevelNavItem>
|
||||||
<TopLevelNavItem href="/api">API</TopLevelNavItem>
|
<TopLevelNavItem href="/api">API</TopLevelNavItem>
|
||||||
<TopLevelNavItem href="https://netbird.io/blog/">Blog</TopLevelNavItem>
|
<TopLevelNavItem href="https://netbird.io/blog/">Blog</TopLevelNavItem>
|
||||||
<TopLevelNavItem href="https://github.com/netbirdio/netbird">Github</TopLevelNavItem>
|
<TopLevelNavItem href="https://github.com/netbirdio/netbird">Github</TopLevelNavItem>
|
||||||
<TopLevelNavItem href="https://join.slack.com/t/netbirdio/shared_invite/zt-vrahf41g-ik1v7fV8du6t0RwxSrJ96A">Support</TopLevelNavItem>
|
<TopLevelNavItem href="https://join.slack.com/t/netbirdio/shared_invite/zt-vrahf41g-ik1v7fV8du6t0RwxSrJ96A">Support</TopLevelNavItem>
|
||||||
{docsNavigation.map((group, groupIndex) => (
|
{docsNavigation.map((group, groupIndex) => (
|
||||||
<NavigationStateProvider key={group.title} index={groupIndex}>
|
<NavigationStateProvider key={group.title} index={groupIndex}>
|
||||||
<NavigationGroup
|
<NavigationGroup
|
||||||
group={group}
|
group={group}
|
||||||
index={groupIndex}
|
index={groupIndex}
|
||||||
className={groupIndex === 0 && 'md:mt-0'}
|
className={groupIndex === 0 && 'md:mt-0'}
|
||||||
/>
|
/>
|
||||||
</NavigationStateProvider>
|
</NavigationStateProvider>
|
||||||
))}
|
))}
|
||||||
<li className="sticky bottom-0 z-10 mt-6 min-[416px]:hidden">
|
<li className="sticky bottom-0 z-10 mt-6 min-[416px]:hidden">
|
||||||
<Button href="https://app.netbird.io/" variant="filled" className="w-full">
|
<Button href="https://app.netbird.io/" variant="filled" className="w-full">
|
||||||
Sign in
|
Sign in
|
||||||
</Button>
|
</Button>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
const findActiveGroupIndex = (group, pathname) => {
|
const findActiveGroupIndex = (group, pathname) => {
|
||||||
let activeIndex = -1;
|
let activeIndex = -1;
|
||||||
group.links.forEach((link, index) => {
|
group.links.forEach((link, index) => {
|
||||||
if (link.href === pathname) {
|
if (link.href === pathname) {
|
||||||
activeIndex = index;
|
activeIndex = index;
|
||||||
} else if (link.links) {
|
} else if (link.links) {
|
||||||
const childIndex = findActiveGroupIndex(link, pathname);
|
const childIndex = findActiveGroupIndex(link, pathname);
|
||||||
if (childIndex !== -1) {
|
if (childIndex !== -1) {
|
||||||
activeIndex = index;
|
activeIndex = index;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
return activeIndex;
|
return activeIndex;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
function NavigationGroup({ group, className, hasChildren }) {
|
function NavigationGroup({ group, className, hasChildren }) {
|
||||||
let router = useRouter()
|
let router = useRouter()
|
||||||
let isActiveGroup = findActiveGroupIndex(group, router.pathname) !== -1;
|
let isActiveGroup = findActiveGroupIndex(group, router.pathname) !== -1;
|
||||||
const [isOpen, setIsOpen] = useState(group.isOpen ? group.isOpen :!hasChildren);
|
const [isOpen, setIsOpen] = useState(group.isOpen ? group.isOpen :!hasChildren);
|
||||||
const [, setActiveHighlight] = useNavigationState();
|
const [, setActiveHighlight] = useNavigationState();
|
||||||
|
|
||||||
return (
|
|
||||||
|
|
||||||
<li className={clsx('relative', className, hasChildren ? "" : "mt-6")}>
|
return (
|
||||||
<motion.h2
|
|
||||||
layout={"size"}
|
|
||||||
className={clsx(
|
|
||||||
"flex justify-between items-center gap-2 group",
|
|
||||||
hasChildren ? "text-zinc-700 select-none py-1 pr-3 hover:text-zinc-900 dark:text-zinc-300 font-medium dark:hover:text-white text-sm cursor-pointer" : "text-xs font-semibold text-zinc-900 dark:text-white"
|
|
||||||
)}
|
|
||||||
onClick={() => {
|
|
||||||
setIsOpen(!isOpen)
|
|
||||||
if(!isOpen) {
|
|
||||||
router.push(group.links[0].href)
|
|
||||||
setActiveHighlight()
|
|
||||||
}else {
|
|
||||||
setActiveHighlight(group.title)
|
|
||||||
}
|
|
||||||
}}
|
|
||||||
data-nb-link={group.title}
|
|
||||||
>
|
|
||||||
{group.title}
|
|
||||||
{hasChildren && <ChevronDownIcon className={clsx("fill-zinc-700 group-hover:fill-zinc-900 dark:fill-zinc-300 dark:group-hover:fill-white","transition", isOpen ? "transform rotate-180" : "")} size={10} />}
|
|
||||||
</motion.h2>
|
|
||||||
<div className={clsx("relative", hasChildren ? "" : "mt-3 pl-2")}>
|
|
||||||
{!hasChildren &&
|
|
||||||
<>
|
|
||||||
<AnimatePresence >
|
|
||||||
{isActiveGroup && (
|
|
||||||
<VisibleSectionHighlight group={group} pathname={router.pathname} />
|
|
||||||
)}
|
|
||||||
</AnimatePresence>
|
|
||||||
<motion.div
|
|
||||||
layout
|
|
||||||
className="absolute inset-y-0 left-2 w-px bg-zinc-900/10 dark:bg-white/5"
|
|
||||||
/>
|
|
||||||
<AnimatePresence initial={false}>
|
|
||||||
{isActiveGroup && (
|
|
||||||
<ActivePageMarker group={group} pathname={router.pathname}/>
|
|
||||||
)}
|
|
||||||
</AnimatePresence>
|
|
||||||
</>
|
|
||||||
}
|
|
||||||
|
|
||||||
<AnimatePresence mode={"wait"} initial={false}>
|
|
||||||
{isOpen && <motion.ul
|
|
||||||
role="list"
|
|
||||||
initial={{ opacity: 0 }}
|
|
||||||
animate={{
|
|
||||||
opacity: 1,
|
|
||||||
transition: { delay: 0.05 },
|
|
||||||
}}
|
|
||||||
exit={{
|
|
||||||
opacity: 0,
|
|
||||||
transition: { duration: 0.15 },
|
|
||||||
}}
|
|
||||||
className="border-l border-transparent">
|
|
||||||
{group.links.map((link) => {
|
|
||||||
return link.href ?
|
|
||||||
<motion.li key={link.href} layout={"position"} className="relative">
|
|
||||||
<NavLink href={link.href} active={link.href === router.pathname} links={link.links}>
|
|
||||||
{link.title}
|
|
||||||
</NavLink>
|
|
||||||
</motion.li>
|
|
||||||
:
|
|
||||||
<NavigationGroup className={"ml-4"} key={link.title + isOpen} group={link} hasChildren={true} />
|
|
||||||
})}
|
|
||||||
</motion.ul>}
|
|
||||||
|
|
||||||
</AnimatePresence>
|
<li className={clsx('relative', className, hasChildren ? "" : "mt-6")}>
|
||||||
</div>
|
<motion.h2
|
||||||
</li>
|
layout={"size"}
|
||||||
)
|
className={clsx(
|
||||||
|
"flex justify-between items-center gap-2 group",
|
||||||
|
hasChildren ? "text-zinc-700 select-none py-1 pr-3 hover:text-zinc-900 dark:text-zinc-300 font-medium dark:hover:text-white text-sm cursor-pointer" : "text-xs font-semibold text-zinc-900 dark:text-white"
|
||||||
|
)}
|
||||||
|
onClick={() => {
|
||||||
|
setIsOpen(!isOpen)
|
||||||
|
if(!isOpen) {
|
||||||
|
router.push(group.links[0].href)
|
||||||
|
setActiveHighlight()
|
||||||
|
}else {
|
||||||
|
setActiveHighlight(group.title)
|
||||||
|
}
|
||||||
|
}}
|
||||||
|
data-nb-link={group.title}
|
||||||
|
>
|
||||||
|
{group.title}
|
||||||
|
{hasChildren && <ChevronDownIcon className={clsx("fill-zinc-700 group-hover:fill-zinc-900 dark:fill-zinc-300 dark:group-hover:fill-white","transition", isOpen ? "transform rotate-180" : "")} size={10} />}
|
||||||
|
</motion.h2>
|
||||||
|
<div className={clsx("relative", hasChildren ? "" : "mt-3 pl-2")}>
|
||||||
|
{!hasChildren &&
|
||||||
|
<>
|
||||||
|
<AnimatePresence >
|
||||||
|
{isActiveGroup && (
|
||||||
|
<VisibleSectionHighlight group={group} pathname={router.pathname} />
|
||||||
|
)}
|
||||||
|
</AnimatePresence>
|
||||||
|
<motion.div
|
||||||
|
layout
|
||||||
|
className="absolute inset-y-0 left-2 w-px bg-zinc-900/10 dark:bg-white/5"
|
||||||
|
/>
|
||||||
|
<AnimatePresence initial={false}>
|
||||||
|
{isActiveGroup && (
|
||||||
|
<ActivePageMarker group={group} pathname={router.pathname}/>
|
||||||
|
)}
|
||||||
|
</AnimatePresence>
|
||||||
|
</>
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
<AnimatePresence mode={"wait"} initial={false}>
|
||||||
|
{isOpen && <motion.ul
|
||||||
|
role="list"
|
||||||
|
initial={{ opacity: 0 }}
|
||||||
|
animate={{
|
||||||
|
opacity: 1,
|
||||||
|
transition: { delay: 0.05 },
|
||||||
|
}}
|
||||||
|
exit={{
|
||||||
|
opacity: 0,
|
||||||
|
transition: { duration: 0.15 },
|
||||||
|
}}
|
||||||
|
className="border-l border-transparent">
|
||||||
|
{group.links.map((link) => {
|
||||||
|
return link.href ?
|
||||||
|
<motion.li key={link.href} layout={"position"} className="relative">
|
||||||
|
<NavLink href={link.href} active={link.href === router.pathname} links={link.links}>
|
||||||
|
{link.title}
|
||||||
|
</NavLink>
|
||||||
|
</motion.li>
|
||||||
|
:
|
||||||
|
<NavigationGroup className={"ml-4"} key={link.title + isOpen} group={link} hasChildren={true} />
|
||||||
|
})}
|
||||||
|
</motion.ul>}
|
||||||
|
|
||||||
|
|
||||||
|
</AnimatePresence>
|
||||||
|
</div>
|
||||||
|
</li>
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
|
|
||||||
# Add machines to your NetBird network
|
# Add peers to your NetBird network
|
||||||
|
|
||||||
Whether you have a network for personal use or manage your company's corporate network, you'd probably want to add machines
|
Whether you have a network for personal use or manage your company's corporate network, you'd probably want to add machines
|
||||||
(or peers in NetBird's terms) to your network.
|
(or peers in NetBird's terms) to your network.
|
||||||
|
|||||||
Reference in New Issue
Block a user