[PR #2226] [MERGED] Feature tvos documentation #2555

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

📋 Pull Request Information

Original PR: https://github.com/juanfont/headscale/pull/2226
Author: @shokinn
Created: 11/4/2024
Status: Merged
Merged: 11/7/2024
Merged by: @kradalby

Base: mainHead: feature-tvos-documentation


📝 Commits (6)

  • b4e867d Add usage documentation for tvOS
  • bb88d9a lint and format
  • 703d6e2 Change admonition to mkdocs flavoured style
  • faef907 fix typos
  • b3d2806 Update hscontrol/templates/apple.go
  • 2c7398f change outer quoting for where quoting in-text is used

📊 Changes

3 files changed (+169 additions, -35 deletions)

View changed files

📝 docs/about/clients.md (+1 -0)
📝 docs/usage/connect/apple.md (+20 -0)
📝 hscontrol/templates/apple.go (+148 -35)

📄 Description

  • 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

Summary

  • Documentation
    • Updated docs/about/clients.md, added tvOS as client.
    • Updated docs/usage/connect/apple.md, added Installation and configuration documentation for tvOS.
    • Updated hscontrol/templates/apple.go to also display the tvOS configuration at /apple on a deployed headscale instance.

🔄 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/2226 **Author:** [@shokinn](https://github.com/shokinn) **Created:** 11/4/2024 **Status:** ✅ Merged **Merged:** 11/7/2024 **Merged by:** [@kradalby](https://github.com/kradalby) **Base:** `main` ← **Head:** `feature-tvos-documentation` --- ### 📝 Commits (6) - [`b4e867d`](https://github.com/juanfont/headscale/commit/b4e867d4729ddc98c57e9be0d9d8ab87b74da5cd) Add usage documentation for tvOS - [`bb88d9a`](https://github.com/juanfont/headscale/commit/bb88d9a2dcc1ca9a54450b29658f191486fda1cf) lint and format - [`703d6e2`](https://github.com/juanfont/headscale/commit/703d6e2643c496251309363c4903277ca8671ae2) Change admonition to mkdocs flavoured style - [`faef907`](https://github.com/juanfont/headscale/commit/faef907672d064f160bb9ede8098a228b9a7b17d) fix typos - [`b3d2806`](https://github.com/juanfont/headscale/commit/b3d280644aa814d55bb8923ee93f317f2f52ea2e) Update hscontrol/templates/apple.go - [`2c7398f`](https://github.com/juanfont/headscale/commit/2c7398fb1d00e85e8716df659cb08e154a3a10b1) change outer quoting for where quoting in-text is used ### 📊 Changes **3 files changed** (+169 additions, -35 deletions) <details> <summary>View changed files</summary> 📝 `docs/about/clients.md` (+1 -0) 📝 `docs/usage/connect/apple.md` (+20 -0) 📝 `hscontrol/templates/apple.go` (+148 -35) </details> ### 📄 Description <!-- Headscale is "Open Source, acknowledged contribution", this means that any contribution will have to be discussed with the Maintainers before being submitted. This model has been chosen to reduce the risk of burnout by limiting the maintenance overhead of reviewing and validating third-party code. Headscale is open to code contributions for bug fixes without discussion. If you find mistakes in the documentation, please submit a fix to the documentation. --> <!-- Please tick if the following things apply. You… --> - [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 - [ ] updated CHANGELOG.md <!-- If applicable, please reference the issue using `Fixes #XXX` and add tests to cover your new code. --> ## Summary - Documentation - Updated `docs/about/clients.md`, added `tvOS` as client. - Updated `docs/usage/connect/apple.md`, added Installation and configuration documentation for tvOS. - Updated `hscontrol/templates/apple.go` to also display the tvOS configuration at `/apple` on a deployed headscale instance. --- <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:47 +01:00
adam closed this issue 2025-12-29 03:21:47 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/headscale#2555