Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature tvos documentation #2226

Merged
merged 6 commits into from
Nov 7, 2024
Merged

Feature tvos documentation #2226

merged 6 commits into from
Nov 7, 2024

Conversation

shokinn
Copy link
Contributor

@shokinn shokinn commented Nov 4, 2024

  • 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.

Copy link
Collaborator

@nblock nblock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution!

I left a few minor suggestions for the docs part.

docs/usage/connect/apple.md Outdated Show resolved Hide resolved
docs/usage/connect/apple.md Outdated Show resolved Hide resolved
hscontrol/templates/apple.go Outdated Show resolved Hide resolved
@shokinn
Copy link
Contributor Author

shokinn commented Nov 5, 2024

Sounds fair.
I've added the requested changes.

@shokinn shokinn requested a review from nblock November 5, 2024 18:24
shokinn and others added 2 commits November 6, 2024 18:23
@kradalby kradalby enabled auto-merge (squash) November 7, 2024 14:04
@kradalby kradalby merged commit 0089cea into juanfont:main Nov 7, 2024
122 of 123 checks passed
hopleus pushed a commit to hopleus/headscale that referenced this pull request Nov 12, 2024
* Add usage documentation for tvOS

* lint and format

* Change admonition to mkdocs flavoured style

* fix typos

* Update hscontrol/templates/apple.go

Co-authored-by: Kristoffer Dalby <kristoffer@dalby.cc>

* change outer quoting for where quoting in-text is used

---------

Co-authored-by: Kristoffer Dalby <kristoffer@dalby.cc>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants