[PR #2292] [MERGED] Prepare docs for 0.24.0 #2589

Closed
opened 2025-12-29 03:21:56 +01:00 by adam · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/juanfont/headscale/pull/2292
Author: @nblock
Created: 12/14/2024
Status: Merged
Merged: 12/17/2024
Merged by: @nblock

Base: mainHead: docs-0.24


📝 Commits (6)

  • 75b8b3a Remove sealos documentation
  • 439419c Changelog: support client verify for DERP
  • 5f75370 Update DNS documentation for dns.extra_records_path
  • 13ddf08 Mention reload and SIGHUP when editing the ACL policy file
  • 67adddf Misc doc updates
  • 00fb93b Set title for code listings

📊 Changes

13 files changed (+97 additions, -83 deletions)

View changed files

📝 CHANGELOG.md (+7 -7)
📝 config-example.yaml (+5 -1)
📝 docs/about/features.md (+2 -1)
📝 docs/ref/acls.md (+8 -5)
📝 docs/ref/dns.md (+61 -29)
📝 docs/ref/integration/reverse-proxy.md (+4 -4)
📝 docs/ref/oidc.md (+4 -4)
📝 docs/ref/remote-cli.md (+2 -2)
📝 docs/ref/tls.md (+2 -2)
docs/setup/install/cloud.md (+0 -25)
📝 docs/setup/install/official.md (+1 -1)
📝 docs/setup/upgrade.md (+1 -1)
📝 mkdocs.yml (+0 -1)

📄 Description

  • Remove sealos docs (the available version there is 0.23.0-beta1 and it seems unmaintained)
  • Update DNS documentation for dns.extra_records_path
  • Mention SIGHUP/reload in ACL docs
  • Update CHANGELOG and fix some links
  • Use title for code blocks for filenames

Preview: https://nblock.github.io/headscale/development/

Fixes #2284
Ref #2304


  • 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/2292 **Author:** [@nblock](https://github.com/nblock) **Created:** 12/14/2024 **Status:** ✅ Merged **Merged:** 12/17/2024 **Merged by:** [@nblock](https://github.com/nblock) **Base:** `main` ← **Head:** `docs-0.24` --- ### 📝 Commits (6) - [`75b8b3a`](https://github.com/juanfont/headscale/commit/75b8b3a774ca8c53c9972af226368d8b5de1f495) Remove sealos documentation - [`439419c`](https://github.com/juanfont/headscale/commit/439419c994d389ea3a35c30dee7c73a0f3622068) Changelog: support client verify for DERP - [`5f75370`](https://github.com/juanfont/headscale/commit/5f753706559cd5cf8fe9becf98800167066ae268) Update DNS documentation for dns.extra_records_path - [`13ddf08`](https://github.com/juanfont/headscale/commit/13ddf0804cb1cab832c95761a3563936fd1bd3ef) Mention reload and SIGHUP when editing the ACL policy file - [`67adddf`](https://github.com/juanfont/headscale/commit/67adddffb059a992ac5a0308ac21b5a5bbbd3842) Misc doc updates - [`00fb93b`](https://github.com/juanfont/headscale/commit/00fb93b6185fd24012e4ea04170386b7373cdca1) Set title for code listings ### 📊 Changes **13 files changed** (+97 additions, -83 deletions) <details> <summary>View changed files</summary> 📝 `CHANGELOG.md` (+7 -7) 📝 `config-example.yaml` (+5 -1) 📝 `docs/about/features.md` (+2 -1) 📝 `docs/ref/acls.md` (+8 -5) 📝 `docs/ref/dns.md` (+61 -29) 📝 `docs/ref/integration/reverse-proxy.md` (+4 -4) 📝 `docs/ref/oidc.md` (+4 -4) 📝 `docs/ref/remote-cli.md` (+2 -2) 📝 `docs/ref/tls.md` (+2 -2) ➖ `docs/setup/install/cloud.md` (+0 -25) 📝 `docs/setup/install/official.md` (+1 -1) 📝 `docs/setup/upgrade.md` (+1 -1) 📝 `mkdocs.yml` (+0 -1) </details> ### 📄 Description * Remove sealos docs (the available version there is 0.23.0-beta1 and it seems unmaintained) * Update DNS documentation for `dns.extra_records_path` * Mention SIGHUP/reload in ACL docs * Update CHANGELOG and fix some links * Use title for code blocks for filenames Preview: https://nblock.github.io/headscale/development/ Fixes #2284 Ref #2304 --- - [x] have read the [CONTRIBUTING.md](./CONTRIBUTING.md) file - [ ] raised a GitHub issue or discussed it on the projects chat beforehand - [ ] added unit tests - [ ] added integration tests - [x] updated documentation if needed - [x] updated CHANGELOG.md --- <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:56 +01:00
adam closed this issue 2025-12-29 03:21:56 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/headscale#2589