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

[PR #262] [MERGED] Rewrite main documentation #1348

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

📋 Pull Request Information

Original PR: https://github.com/juanfont/headscale/pull/262
Author: @kradalby
Created: 1/2/2022
Status: ✅ Merged
Merged: 1/4/2022
Merged by: @kradalby

Base: main ← Head: improve-docs

📝 Commits (10+)

  • f9e6722 Rewrite main documentation
  • 74fd5de Move kubernetes example under docs
  • 8a07a63 Write disclaimer in kubernetes example
  • 8d504c3 Move kubernetes to kustomize, since thats what it is
  • a75c5a4 Add eradme to examples
  • a11c6fd Fix formatting error in container doc
  • 3ce3ccb Reorder tls docs
  • 80d196c Remove DNS file, it will be merged into example configuration
  • 271cb71 Add more explaination and less redunancy with docs
  • 86f36f9 Lowercase markdown docs

📊 Changes

32 files changed (+459 additions, -335 deletions)

View changed files

📝 cmd/headscale/headscale_test.go (+1 -2)
📝 config-example.yaml (+89 -11)
➖ docs/Configuration.md (+0 -74)
➖ docs/DNS.md (+0 -37)
📝 docs/README.md (+41 -6)
➖ docs/Running.md (+0 -193)
➕ docs/examples/README.md (+5 -0)
📝 docs/examples/kustomize/.gitignore (+0 -0)
📝 docs/examples/kustomize/README.md (+3 -1)
📝 docs/examples/kustomize/base/configmap.yaml (+0 -0)
📝 docs/examples/kustomize/base/ingress.yaml (+0 -0)
📝 docs/examples/kustomize/base/kustomization.yaml (+0 -0)
📝 docs/examples/kustomize/base/service.yaml (+0 -0)
📝 docs/examples/kustomize/headscale.bash (+0 -0)
📝 docs/examples/kustomize/init.bash (+0 -0)
📝 docs/examples/kustomize/install-cert-manager.bash (+0 -0)
📝 docs/examples/kustomize/postgres/deployment.yaml (+0 -0)
📝 docs/examples/kustomize/postgres/kustomization.yaml (+0 -0)
📝 docs/examples/kustomize/postgres/postgres-service.yaml (+0 -0)
📝 docs/examples/kustomize/postgres/postgres-statefulset.yaml (+0 -0)

...and 12 more files

📄 Description

This commit starts restructuring the documentation and updating it to be
compliant with 0.12.x+ releases.

The main change is that the documentation has been rewritten for the
ground up, and hopefully simplified.

The documentation has been split into an official documentation for
running headscale as a binary under Linux with SystemD and a "community"
provided documentation for Docker.

This should make the two documents a lot easier to read and follow than
the mishmash documentation we had.

@cure @ohdearaugustin @juanfont

🔄 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/262 **Author:** [@kradalby](https://github.com/kradalby) **Created:** 1/2/2022 **Status:** ✅ Merged **Merged:** 1/4/2022 **Merged by:** [@kradalby](https://github.com/kradalby) **Base:** `main` ← **Head:** `improve-docs` --- ### 📝 Commits (10+) - [`f9e6722`](https://github.com/juanfont/headscale/commit/f9e67226353245e587a0d1d311aef693fc218322) Rewrite main documentation - [`74fd5de`](https://github.com/juanfont/headscale/commit/74fd5de43da839ce6d8103982dadeba3a17f7e9d) Move kubernetes example under docs - [`8a07a63`](https://github.com/juanfont/headscale/commit/8a07a63b1c71af340a0efccf2f1d7792138da868) Write disclaimer in kubernetes example - [`8d504c3`](https://github.com/juanfont/headscale/commit/8d504c35bf4aefc6931e357f6814d1718139bf89) Move kubernetes to kustomize, since thats what it is - [`a75c5a4`](https://github.com/juanfont/headscale/commit/a75c5a4cff93a3ec654f80e78eace9b65d18c3ea) Add eradme to examples - [`a11c6fd`](https://github.com/juanfont/headscale/commit/a11c6fd8b99d9457247fd8fe69e5c736e9f61b7c) Fix formatting error in container doc - [`3ce3ccb`](https://github.com/juanfont/headscale/commit/3ce3ccb559b28cde87cb496be03510a13b927c04) Reorder tls docs - [`80d196c`](https://github.com/juanfont/headscale/commit/80d196cbfd30dc9b81d9a7033fa1bd409aafdbf8) Remove DNS file, it will be merged into example configuration - [`271cb71`](https://github.com/juanfont/headscale/commit/271cb71754961cfe9a1cc3e82917255e9cd8fa4e) Add more explaination and less redunancy with docs - [`86f36f9`](https://github.com/juanfont/headscale/commit/86f36f9a43ba13ac75a55243c397f687aa939060) Lowercase markdown docs ### 📊 Changes **32 files changed** (+459 additions, -335 deletions) <details> <summary>View changed files</summary> 📝 `cmd/headscale/headscale_test.go` (+1 -2) 📝 `config-example.yaml` (+89 -11) ➖ `docs/Configuration.md` (+0 -74) ➖ `docs/DNS.md` (+0 -37) 📝 `docs/README.md` (+41 -6) ➖ `docs/Running.md` (+0 -193) ➕ `docs/examples/README.md` (+5 -0) 📝 `docs/examples/kustomize/.gitignore` (+0 -0) 📝 `docs/examples/kustomize/README.md` (+3 -1) 📝 `docs/examples/kustomize/base/configmap.yaml` (+0 -0) 📝 `docs/examples/kustomize/base/ingress.yaml` (+0 -0) 📝 `docs/examples/kustomize/base/kustomization.yaml` (+0 -0) 📝 `docs/examples/kustomize/base/service.yaml` (+0 -0) 📝 `docs/examples/kustomize/headscale.bash` (+0 -0) 📝 `docs/examples/kustomize/init.bash` (+0 -0) 📝 `docs/examples/kustomize/install-cert-manager.bash` (+0 -0) 📝 `docs/examples/kustomize/postgres/deployment.yaml` (+0 -0) 📝 `docs/examples/kustomize/postgres/kustomization.yaml` (+0 -0) 📝 `docs/examples/kustomize/postgres/postgres-service.yaml` (+0 -0) 📝 `docs/examples/kustomize/postgres/postgres-statefulset.yaml` (+0 -0) _...and 12 more files_ </details> ### 📄 Description This commit starts restructuring the documentation and updating it to be compliant with 0.12.x+ releases. The main change is that the documentation has been rewritten for the ground up, and hopefully simplified. The documentation has been split into an official documentation for running headscale as a binary under Linux with SystemD and a "community" provided documentation for Docker. This should make the two documents a lot easier to read and follow than the mishmash documentation we had. @cure @ohdearaugustin @juanfont --- <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 02:29:47 +01:00
adam closed this issue 2025-12-29 02:29:47 +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#1348
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?