starred/headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2026-01-12 04:10:32 +01:00
Code Issues 98 Packages Projects Releases 10 Wiki Activity

[PR #1293] [MERGED] Build static site with documentation #2021

New Issue
Closed
opened 2025-12-29 03:19:19 +01:00 by adam · 0 comments
adam commented 2025-12-29 03:19:19 +01:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/juanfont/headscale/pull/1293
Author: @Orhideous
Created: 3/27/2023
Status: ✅ Merged
Merged: 4/7/2023
Merged by: @juanfont

Base: main ← Head: docs

📝 Commits (10+)

  • b6bd2bd Configure MkDocs Material scaffold
  • 322fcaa Add admonitions marking community-provided docs
  • 0348523 Add admonitions marking community-provided docs
  • a85dd76 Move admonitions to relevant sections
  • 4c963d8 Add new index page
  • 7a51a8a Add GHA CI to build and deploy docs
  • f97989a Replace placeholder link with actual one
  • 7dd6c8c Move examples out of docs/ directory
  • 5896966 Build with strict mode
  • 04c0b16 Removed custom accents, going with defaults

📊 Changes

34 files changed (+252 additions, -64 deletions)

View changed files

➕ .github/workflows/docs.yml (+45 -0)
📝 .gitignore (+4 -0)
➖ docs/README.md (+0 -56)
📝 docs/acls.md (+12 -1)
📝 docs/dns-records.md (+7 -0)
📝 docs/iOS-client.md (+5 -0)
➕ docs/index.md (+12 -0)
📝 docs/reverse-proxy.md (+7 -0)
📝 docs/running-headscale-container.md (+7 -3)
📝 docs/running-headscale-linux.md (+1 -2)
📝 docs/running-headscale-openbsd.md (+8 -2)
📝 examples/README.md (+0 -0)
📝 examples/kustomize/.gitignore (+0 -0)
📝 examples/kustomize/README.md (+0 -0)
📝 examples/kustomize/base/configmap.yaml (+0 -0)
📝 examples/kustomize/base/ingress.yaml (+0 -0)
📝 examples/kustomize/base/kustomization.yaml (+0 -0)
📝 examples/kustomize/base/service.yaml (+0 -0)
📝 examples/kustomize/headscale.bash (+0 -0)
📝 examples/kustomize/init.bash (+0 -0)

...and 14 more files

📄 Description

This PR builds available docs into static site on Github Pages, example here.

  • read the CONTRIBUTING guidelines
  • 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/1293 **Author:** [@Orhideous](https://github.com/Orhideous) **Created:** 3/27/2023 **Status:** ✅ Merged **Merged:** 4/7/2023 **Merged by:** [@juanfont](https://github.com/juanfont) **Base:** `main` ← **Head:** `docs` --- ### 📝 Commits (10+) - [`b6bd2bd`](https://github.com/juanfont/headscale/commit/b6bd2bd762c6d8f590a5798668920a440e985ab3) Configure MkDocs Material scaffold - [`322fcaa`](https://github.com/juanfont/headscale/commit/322fcaad2cad2c5f951e700df6c921193a989d61) Add admonitions marking community-provided docs - [`0348523`](https://github.com/juanfont/headscale/commit/03485239032bf798cda3e5a2ef46da66892cdf7b) Add admonitions marking community-provided docs - [`a85dd76`](https://github.com/juanfont/headscale/commit/a85dd763200080ca1d5048f368a25fcff19bcfea) Move admonitions to relevant sections - [`4c963d8`](https://github.com/juanfont/headscale/commit/4c963d8aa94579d1af1d8566b5886953f1db413d) Add new index page - [`7a51a8a`](https://github.com/juanfont/headscale/commit/7a51a8a45aa41a11774a6280ab74ceaed36ea1bb) Add GHA CI to build and deploy docs - [`f97989a`](https://github.com/juanfont/headscale/commit/f97989a05dc9022ab183cc419fcbabc845d38513) Replace placeholder link with actual one - [`7dd6c8c`](https://github.com/juanfont/headscale/commit/7dd6c8c763403208970896b7a3335a2123da59d5) Move examples out of docs/ directory - [`5896966`](https://github.com/juanfont/headscale/commit/5896966c30b9ce69ff1397c935cd3cf228b1af5d) Build with strict mode - [`04c0b16`](https://github.com/juanfont/headscale/commit/04c0b16dfe9e17454ca3c930c1bf908e609ecc1d) Removed custom accents, going with defaults ### 📊 Changes **34 files changed** (+252 additions, -64 deletions) <details> <summary>View changed files</summary> ➕ `.github/workflows/docs.yml` (+45 -0) 📝 `.gitignore` (+4 -0) ➖ `docs/README.md` (+0 -56) 📝 `docs/acls.md` (+12 -1) 📝 `docs/dns-records.md` (+7 -0) 📝 `docs/iOS-client.md` (+5 -0) ➕ `docs/index.md` (+12 -0) 📝 `docs/reverse-proxy.md` (+7 -0) 📝 `docs/running-headscale-container.md` (+7 -3) 📝 `docs/running-headscale-linux.md` (+1 -2) 📝 `docs/running-headscale-openbsd.md` (+8 -2) 📝 `examples/README.md` (+0 -0) 📝 `examples/kustomize/.gitignore` (+0 -0) 📝 `examples/kustomize/README.md` (+0 -0) 📝 `examples/kustomize/base/configmap.yaml` (+0 -0) 📝 `examples/kustomize/base/ingress.yaml` (+0 -0) 📝 `examples/kustomize/base/kustomization.yaml` (+0 -0) 📝 `examples/kustomize/base/service.yaml` (+0 -0) 📝 `examples/kustomize/headscale.bash` (+0 -0) 📝 `examples/kustomize/init.bash` (+0 -0) _...and 14 more files_ </details> ### 📄 Description This PR builds available docs into static site on Github Pages, [example here](https://orhideous.github.io/headscale/). - [x] read the [CONTRIBUTING guidelines](README.md#contributing) - [ ] 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 --- <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:19:19 +01:00
adam closed this issue 2025-12-29 03:19:20 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
CLI
DERP
DNS
Nix
OIDC
SSH
bug
database
documentation
duplicate
enhancement
faq
good first issue
grants
help wanted
might-come
needs design doc
needs investigation
no-stale-bot
out of scope
performance
policy 📝
pull-request
Mirrored from GitHub Pull Request
 question
regression
routes
stale
tags
tailscale-feature-gap
well described ❤️
wontfix
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/headscale#2021
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?