public/headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2025-11-13 11:22:46 +09:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity
3,280 Commits 69 Branches 148 Tags
f7b0cbbbea77d27203ece5eb3ba2f893c47e806d
Commit Graph

3 Commits

Author SHA1 Message Date
nblock
29119bb7f4 Misc doc fixes (#2240) 
* Link back to node registration docs
* adjust wording in apple docs
* Mention client specific page to check if headscale works

Ref: #2238
 2024-11-18 05:46:58 +01:00
Philip Henning
0089ceaf1d Feature tvos documentation (#2226)
Some checks failed
Build / build (push) Has been cancelled
Details
Build documentation / build (push) Has been cancelled
Details
Tests / test (push) Has been cancelled
Details
Build documentation / deploy (push) Has been cancelled
Details
update-flake-lock / lockfile (push) Has been cancelled
Details
GitHub Actions Version Updater / build (push) Has been cancelled
Details 
* 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>
 2024-11-07 14:56:18 +00:00
nblock
8c7d8ee34f Restructure headscale documentation (#2163)
Some checks are pending
Build / build (push) Waiting to run
Details
Build documentation / build (push) Waiting to run
Details
Build documentation / deploy (push) Blocked by required conditions
Details
Tests / test (push) Waiting to run
Details 
* Setup mkdocs-redirects

* Restructure existing documentation

* Move client OS support into the documentation

* Move existing Client OS support table into its own documentation page
* Link from README.md to the rendered documentation
* Document minimum Tailscale client version

* Reuse CONTRIBUTING.md" in the documentation

* Include "CONTRIBUTING.md" from the repository root
* Update FAQ and index page and link to the contributing docs

* Add configuration reference

* Add a getting started page and explain the first steps with headscale

* Use the existing "Using headscale" sections and combine them into a
  single getting started guide with a little bit more explanation.
* Explain how to get help from the command line client.
* Remove duplicated sections from existing installation guides

* Document requirements and assumptions

* Document packages provided by the community

* Move deb install guide to official releases

* Move manual install guide to official releases

* Move container documentation to setup section

* Move sealos documentation to cloud install page

* Move OpenBSD docs to build from source

* Simplify DNS documentation

* Add sponsor page

* Add releases page

* Add features page

* Add help page

* Add upgrading page

* Adjust mkdocs nav

* Update wording

Use the term headscale for the project, Headscale on the beginning of a
sentence and `headscale` when refering to the CLI.

* Welcome to headscale

* Link to existing documentation in the FAQ

* Remove the goal header and use the text as opener

* Indent code block in OIDC

* Make a few pages linter compatible

Also update ignored files for prettier

* Recommend HTTPS on port 443

Fixes: #2164

* Use hosts in acl documentation

thx @efficacy38 for noticing this

Ref: #1863

* Use mkdocs-macros to set headscale version once
 2024-10-10 15:24:04 +02:00