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 #184] [MERGED] Move documentation away from README and use YAML everywhere #1306

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

📋 Pull Request Information

Original PR: https://github.com/juanfont/headscale/pull/184
Author: @juanfont
Created: 10/19/2021
Status: ✅ Merged
Merged: 10/21/2021
Merged by: @juanfont

Base: main ← Head: doc-reorg-v1

📝 Commits (10+)

📊 Changes

16 files changed (+383 additions, -321 deletions)

View changed files

📝 .github/workflows/build.yml (+1 -1)
➕ .github/workflows/contributors.yml (+22 -0)
📝 .github/workflows/release.yml (+10 -18)
📝 .goreleaser.yml (+7 -8)
📝 README.md (+8 -217)
📝 cmd/headscale/headscale_test.go (+3 -3)
➖ config.json.postgres.example (+0 -30)
➖ config.json.sqlite.example (+0 -26)
➕ config.yaml.postgres.example (+30 -0)
➕ config.yaml.sqlite.example (+26 -0)
➕ docs/Configuration.md (+80 -0)
📝 docs/DNS.md (+11 -12)
➕ docs/Glossary.md (+3 -0)
➕ docs/Running.md (+149 -0)
➕ docs/TLS.md (+27 -0)
📝 k8s/README.md (+6 -6)

📄 Description

This PR moves the documentation we had in README.md into separate files in docs/.

It also converts the examples into YAML, as per #181.

🔄 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/184 **Author:** [@juanfont](https://github.com/juanfont) **Created:** 10/19/2021 **Status:** ✅ Merged **Merged:** 10/21/2021 **Merged by:** [@juanfont](https://github.com/juanfont) **Base:** `main` ← **Head:** `doc-reorg-v1` --- ### 📝 Commits (10+) - [`7bb3541`](https://github.com/juanfont/headscale/commit/7bb354117be2b0838a45c23dc0e9e85c068ee63f) Move README documentation to doc/ - [`2236cc8`](https://github.com/juanfont/headscale/commit/2236cc8bf7c3d8a69f27e96295f998fee746b0b8) Improve wording here and there - [`995dcfc`](https://github.com/juanfont/headscale/commit/995dcfc6aebe520208cfd0f04679803ed17efa05) Reference doc/ - [`0318af5`](https://github.com/juanfont/headscale/commit/0318af5a332b32a6787cee08051ebd1920f2bdac) Apply suggestions from code review - [`06706aa`](https://github.com/juanfont/headscale/commit/06706aab9a408f8780aefee2c43f3d5d0814ff24) Update docs/Running.md - [`7b40e99`](https://github.com/juanfont/headscale/commit/7b40e99aec28ef0a06457712f6f758a27a9c5665) Added notes on SQLite - [`efe208f`](https://github.com/juanfont/headscale/commit/efe208fef5f7c0ceb05d32ea1bf7ffb90911cfab) Merge branch 'doc-reorg-v1' of https://github.com/juanfont/headscale into doc-reorg-v1 - [`d1e8ac7`](https://github.com/juanfont/headscale/commit/d1e8ac7ba5f1a8f748f87465bb66be61af48b5f4) Moved TLS config to another file - [`86ecc2a`](https://github.com/juanfont/headscale/commit/86ecc2a234a9f44331b1f88c15656335af313fe5) Switch to YAML config - [`3134412`](https://github.com/juanfont/headscale/commit/31344128a012b722b763baabf4bf8ea88282c882) Switch json for yaml in README ### 📊 Changes **16 files changed** (+383 additions, -321 deletions) <details> <summary>View changed files</summary> 📝 `.github/workflows/build.yml` (+1 -1) ➕ `.github/workflows/contributors.yml` (+22 -0) 📝 `.github/workflows/release.yml` (+10 -18) 📝 `.goreleaser.yml` (+7 -8) 📝 `README.md` (+8 -217) 📝 `cmd/headscale/headscale_test.go` (+3 -3) ➖ `config.json.postgres.example` (+0 -30) ➖ `config.json.sqlite.example` (+0 -26) ➕ `config.yaml.postgres.example` (+30 -0) ➕ `config.yaml.sqlite.example` (+26 -0) ➕ `docs/Configuration.md` (+80 -0) 📝 `docs/DNS.md` (+11 -12) ➕ `docs/Glossary.md` (+3 -0) ➕ `docs/Running.md` (+149 -0) ➕ `docs/TLS.md` (+27 -0) 📝 `k8s/README.md` (+6 -6) </details> ### 📄 Description This PR moves the documentation we had in README.md into separate files in `docs/`. It also converts the examples into YAML, as per #181. --- <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:38 +01:00
adam closed this issue 2025-12-29 02:29:38 +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#1306
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?