starred/headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2026-01-11 11:50:30 +01:00
Code Issues 98 Packages Projects Releases 10 Wiki Activity

[PR #2163] [MERGED] Restructure headscale documentation #2531

New Issue
Closed
opened 2025-12-29 03:21:41 +01:00 by adam · 0 comments
adam commented 2025-12-29 03:21:41 +01:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/juanfont/headscale/pull/2163
Author: @nblock
Created: 10/2/2024
Status: ✅ Merged
Merged: 10/10/2024
Merged by: @kradalby

Base: main ← Head: docs

📝 Commits (10+)

  • 8e2aab7 Setup mkdocs-redirects
  • 5a432ee Restructure existing documentation
  • 5c11224 Move client OS support into the documentation
  • 9cdaa36 Reuse CONTRIBUTING.md" in the documentation
  • 35f8395 Add configuration reference
  • 40e226c Add a getting started page and explain the first steps with headscale
  • ba5b944 Document requirements and assumptions
  • 3f8b73e Document packages provided by the community
  • cbe2483 Move deb install guide to official releases
  • 68e9e68 Move manual install guide to official releases

📊 Changes

41 files changed (+867 additions, -942 deletions)

View changed files

📝 .prettierignore (+1 -5)
📝 README.md (+3 -23)
📝 config-example.yaml (+2 -2)
➕ docs/about/clients.md (+15 -0)
➕ docs/about/contributing.md (+3 -0)
📝 docs/about/faq.md (+14 -17)
➕ docs/about/features.md (+31 -0)
➕ docs/about/help.md (+11 -0)
➕ docs/about/releases.md (+10 -0)
➕ docs/about/sponsor.md (+4 -0)
➖ docs/dns-records.md (+0 -92)
➖ docs/images/headscale-sealos-grpc-url.png (+0 -0)
➖ docs/images/headscale-sealos-url.png (+0 -0)
📝 docs/index.md (+6 -7)
📝 docs/ref/acls.md (+3 -3)
➕ docs/ref/configuration.md (+39 -0)
➕ docs/ref/dns.md (+80 -0)
📝 docs/ref/exit-node.md (+0 -0)
📝 docs/ref/integration/reverse-proxy.md (+3 -3)
📝 docs/ref/integration/web-ui.md (+3 -3)

...and 21 more files

📄 Description

Following the spirit of the 0.23 release, this PR aims to restructure the existing documentation to improve
maintanability while providing more information to users. It is mainly a preparation for versioned documentation in the
future which will allow us to evolve the documentation alongside headscale releases. Relevant aspects of this PR:

  • Split the documentation into multiple sections:
    • About: Information about the project: FAQ, features, client compat, contributing, …
    • Setup: Requirements, Install page for varous release, Upgrading
    • Usage: "Getting started", Connecting with Android/Apple/Windows
    • Reference: specific documentation (acl, dns, oidc, …) and integration with other components (reverse proxy, Web UI)
  • Remove duplication and split the common parts into their own pages
  • Document more ways to install headscale (official binaries and packages, distribution, container, …).
  • Add a configuration reference
  • Reuse existing documentation such as CONTRIBUTING.md
  • Replace duplicate content in the README with links to the docs (features, client)
  • Update wording to headscale (in regular text), Headscale (beginning of a sentence) and headscale when referring to the CLI.
  • Add redirects from old links to the new pages

A preview is available here: https://nblock.github.io/headscale/

Fixes: #2164
Ref: #1863

  • have read the CONTRIBUTING.md file
  • raised a GitHub issue or discussed it on the projects chat beforehand
  • added unit tests
  • added integration tests
  • updated documentation if needed
  • updated CHANGELOG.md

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/juanfont/headscale/pull/2163 **Author:** [@nblock](https://github.com/nblock) **Created:** 10/2/2024 **Status:** ✅ Merged **Merged:** 10/10/2024 **Merged by:** [@kradalby](https://github.com/kradalby) **Base:** `main` ← **Head:** `docs` --- ### 📝 Commits (10+) - [`8e2aab7`](https://github.com/juanfont/headscale/commit/8e2aab75e2c8686882356d9ee9f61bfd6da0a419) Setup mkdocs-redirects - [`5a432ee`](https://github.com/juanfont/headscale/commit/5a432ee2d3c9259eac1e92a4063ce0eecc866853) Restructure existing documentation - [`5c11224`](https://github.com/juanfont/headscale/commit/5c112241d8cdeefaad40f86b32fdfbd6d991c9e4) Move client OS support into the documentation - [`9cdaa36`](https://github.com/juanfont/headscale/commit/9cdaa360c9d8ccd0680c9901b17253e0aa108e15) Reuse CONTRIBUTING.md" in the documentation - [`35f8395`](https://github.com/juanfont/headscale/commit/35f8395df77d2f58f6ac3ff977b3adaaa6aff237) Add configuration reference - [`40e226c`](https://github.com/juanfont/headscale/commit/40e226c9eecef8bb66f0c7b5b712fa0d75897f74) Add a getting started page and explain the first steps with headscale - [`ba5b944`](https://github.com/juanfont/headscale/commit/ba5b9444265abab7a83c692c0bfea935dc9c1d61) Document requirements and assumptions - [`3f8b73e`](https://github.com/juanfont/headscale/commit/3f8b73e0a8a46d4e4500430e11bb68a425498de8) Document packages provided by the community - [`cbe2483`](https://github.com/juanfont/headscale/commit/cbe2483d451570417e9faff247d3da4be9efca5f) Move deb install guide to official releases - [`68e9e68`](https://github.com/juanfont/headscale/commit/68e9e6809e94bdc86472f49c15008abb6258f6d7) Move manual install guide to official releases ### 📊 Changes **41 files changed** (+867 additions, -942 deletions) <details> <summary>View changed files</summary> 📝 `.prettierignore` (+1 -5) 📝 `README.md` (+3 -23) 📝 `config-example.yaml` (+2 -2) ➕ `docs/about/clients.md` (+15 -0) ➕ `docs/about/contributing.md` (+3 -0) 📝 `docs/about/faq.md` (+14 -17) ➕ `docs/about/features.md` (+31 -0) ➕ `docs/about/help.md` (+11 -0) ➕ `docs/about/releases.md` (+10 -0) ➕ `docs/about/sponsor.md` (+4 -0) ➖ `docs/dns-records.md` (+0 -92) ➖ `docs/images/headscale-sealos-grpc-url.png` (+0 -0) ➖ `docs/images/headscale-sealos-url.png` (+0 -0) 📝 `docs/index.md` (+6 -7) 📝 `docs/ref/acls.md` (+3 -3) ➕ `docs/ref/configuration.md` (+39 -0) ➕ `docs/ref/dns.md` (+80 -0) 📝 `docs/ref/exit-node.md` (+0 -0) 📝 `docs/ref/integration/reverse-proxy.md` (+3 -3) 📝 `docs/ref/integration/web-ui.md` (+3 -3) _...and 21 more files_ </details> ### 📄 Description Following the spirit of the 0.23 release, this PR aims to restructure the existing documentation to improve maintanability while providing more information to users. It is mainly a preparation for versioned documentation in the future which will allow us to evolve the documentation alongside headscale releases. Relevant aspects of this PR: * Split the documentation into multiple sections: * About: Information about the project: FAQ, features, client compat, contributing, … * Setup: Requirements, Install page for varous release, Upgrading * Usage: "Getting started", Connecting with Android/Apple/Windows * Reference: specific documentation (acl, dns, oidc, …) and integration with other components (reverse proxy, Web UI) * Remove duplication and split the common parts into their own pages * Document more ways to install headscale (official binaries and packages, distribution, container, …). * Add a configuration reference * Reuse existing documentation such as CONTRIBUTING.md * Replace duplicate content in the README with links to the docs (features, client) * Update wording to headscale (in regular text), Headscale (beginning of a sentence) and `headscale` when referring to the CLI. * Add redirects from old links to the new pages A preview is available here: <https://nblock.github.io/headscale/> Fixes: #2164 Ref: #1863 --- - [x] have read the [CONTRIBUTING.md](./CONTRIBUTING.md) file - [x] raised a GitHub issue or discussed it on the projects chat beforehand - [ ] added unit tests - [ ] added integration tests - [x] updated documentation if needed - [ ] updated CHANGELOG.md <!-- If applicable, please reference the issue using `Fixes #XXX` and add tests to cover your new code. --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2025-12-29 03:21:41 +01:00
adam closed this issue 2025-12-29 03:21:41 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
CLI
DERP
DNS
Nix
OIDC
SSH
bug
database
documentation
duplicate
enhancement
faq
good first issue
grants
help wanted
might-come
needs design doc
needs investigation
no-stale-bot
out of scope
performance
policy 📝
pull-request
Mirrored from GitHub Pull Request
 question
regression
routes
stale
tags
tailscale-feature-gap
well described ❤️
wontfix
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/headscale#2531
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?