From 5a432ee2d3c9259eac1e92a4063ce0eecc866853 Mon Sep 17 00:00:00 2001 From: Florian Preinstorfer Date: Fri, 13 Sep 2024 19:01:42 +0200 Subject: [PATCH] Restructure existing documentation --- docs/{ => about}/faq.md | 5 -- docs/index.md | 2 +- docs/{ => ref}/acls.md | 2 +- docs/{dns-records.md => ref/dns.md} | 0 docs/{ => ref}/exit-node.md | 0 docs/{ => ref/integration}/reverse-proxy.md | 0 docs/{ => ref/integration}/web-ui.md | 0 docs/{ => ref}/oidc.md | 0 docs/{ => ref}/remote-cli.md | 0 docs/{ => ref}/tls.md | 0 .../connect/android.md} | 0 .../connect/apple.md} | 0 .../connect/windows.md} | 0 mkdocs.yml | 46 +++++++++++++------ 14 files changed, 33 insertions(+), 22 deletions(-) rename docs/{ => about}/faq.md (99%) rename docs/{ => ref}/acls.md (99%) rename docs/{dns-records.md => ref/dns.md} (100%) rename docs/{ => ref}/exit-node.md (100%) rename docs/{ => ref/integration}/reverse-proxy.md (100%) rename docs/{ => ref/integration}/web-ui.md (100%) rename docs/{ => ref}/oidc.md (100%) rename docs/{ => ref}/remote-cli.md (100%) rename docs/{ => ref}/tls.md (100%) rename docs/{android-client.md => usage/connect/android.md} (100%) rename docs/{apple-client.md => usage/connect/apple.md} (100%) rename docs/{windows-client.md => usage/connect/windows.md} (100%) diff --git a/docs/faq.md b/docs/about/faq.md similarity index 99% rename from docs/faq.md rename to docs/about/faq.md index 2a459967..610235b7 100644 --- a/docs/faq.md +++ b/docs/about/faq.md @@ -1,8 +1,3 @@ ---- -hide: - - navigation ---- - # Frequently Asked Questions ## What is the design goal of headscale? diff --git a/docs/index.md b/docs/index.md index f1b6e1b1..29cf43d6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,7 +8,7 @@ hide: `headscale` is an open source, self-hosted implementation of the Tailscale control server. -This page contains the documentation for the latest version of headscale. Please also check our [FAQ](faq.md). +This page contains the documentation for the latest version of headscale. Please also check our [FAQ](./about/faq.md). Join our [Discord](https://discord.gg/c84AZQhmpx) server for a chat and community support. diff --git a/docs/acls.md b/docs/ref/acls.md similarity index 99% rename from docs/acls.md rename to docs/ref/acls.md index 4ab8fb46..ef799f2c 100644 --- a/docs/acls.md +++ b/docs/ref/acls.md @@ -36,7 +36,7 @@ servers. - billing.internal - router.internal -![ACL implementation example](images/headscale-acl-network.png) +![ACL implementation example](../images/headscale-acl-network.png) ## ACL setup diff --git a/docs/dns-records.md b/docs/ref/dns.md similarity index 100% rename from docs/dns-records.md rename to docs/ref/dns.md diff --git a/docs/exit-node.md b/docs/ref/exit-node.md similarity index 100% rename from docs/exit-node.md rename to docs/ref/exit-node.md diff --git a/docs/reverse-proxy.md b/docs/ref/integration/reverse-proxy.md similarity index 100% rename from docs/reverse-proxy.md rename to docs/ref/integration/reverse-proxy.md diff --git a/docs/web-ui.md b/docs/ref/integration/web-ui.md similarity index 100% rename from docs/web-ui.md rename to docs/ref/integration/web-ui.md diff --git a/docs/oidc.md b/docs/ref/oidc.md similarity index 100% rename from docs/oidc.md rename to docs/ref/oidc.md diff --git a/docs/remote-cli.md b/docs/ref/remote-cli.md similarity index 100% rename from docs/remote-cli.md rename to docs/ref/remote-cli.md diff --git a/docs/tls.md b/docs/ref/tls.md similarity index 100% rename from docs/tls.md rename to docs/ref/tls.md diff --git a/docs/android-client.md b/docs/usage/connect/android.md similarity index 100% rename from docs/android-client.md rename to docs/usage/connect/android.md diff --git a/docs/apple-client.md b/docs/usage/connect/apple.md similarity index 100% rename from docs/apple-client.md rename to docs/usage/connect/apple.md diff --git a/docs/windows-client.md b/docs/usage/connect/windows.md similarity index 100% rename from docs/windows-client.md rename to docs/usage/connect/windows.md diff --git a/mkdocs.yml b/mkdocs.yml index 798faadc..4e003c4b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -71,7 +71,19 @@ plugins: - social: {} - redirects: redirect_maps: - 'iOS-client.md': 'apple-client.md#ios' + acls.md: ref/acls.md + android-client.md: usage/connect/android.md + apple-client.md: usage/connect/apple.md + dns-records.md: ref/dns.md + exit-node.md: ref/exit-node.md + faq.md: about/faq.md + iOS-client.md: usage/connect/apple.md#ios + oidc.md: ref/oidc.md + remote-cli.md: ref/remote-cli.md + reverse-proxy.md: ref/integration/reverse-proxy.md + tls.md: ref/tls.md + web-ui.md: ref/integration/web-ui.md + windows-client.md: usage/connect/windows.md # Customization extra: @@ -132,22 +144,26 @@ markdown_extensions: # Page tree nav: - Home: index.md - - FAQ: faq.md + - About: + - FAQ: about/faq.md + - Usage: + - Connect a node: + - Android: usage/connect/android.md + - Apple: usage/connect/apple.md + - Windows: usage/connect/windows.md + - Reference: + - OIDC authentication: ref/oidc.md + - Exit node: ref/exit-node.md + - TLS: ref/tls.md + - ACLs: ref/acls.md + - DNS: ref/dns.md + - Remote CLI: ref/remote-cli.md + - Integration: + - Reverse proxy: ref/integration/reverse-proxy.md + - Web UI: ref/integration/web-ui.md + - Getting started: - Installation: - Linux: running-headscale-linux.md - OpenBSD: running-headscale-openbsd.md - Container: running-headscale-container.md - - Configuration: - - Web UI: web-ui.md - - OIDC authentication: oidc.md - - Exit node: exit-node.md - - Reverse proxy: reverse-proxy.md - - TLS: tls.md - - ACLs: acls.md - - Custom DNS records: dns-records.md - - Remote CLI: remote-cli.md - - Usage: - - Android: android-client.md - - Apple: apple-client.md - - Windows: windows-client.md