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

[PR #2265] [MERGED] Add versioned documentation #2576

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

📋 Pull Request Information

Original PR: https://github.com/juanfont/headscale/pull/2265
Author: @nblock
Created: 11/30/2024
Status: ✅ Merged
Merged: 12/2/2024
Merged by: @nblock

Base: main ← Head: versioned

📝 Commits (1)

  • 4bd11a5 Add versioned documentation

📊 Changes

4 files changed (+53 additions, -52 deletions)

View changed files

➕ .github/workflows/docs-deploy.yml (+48 -0)
➖ .github/workflows/docs.yml (+0 -52)
📝 docs/requirements.txt (+1 -0)
📝 mkdocs.yml (+4 -0)

📄 Description

Setup mike to provide versioned builds of the documentation.

The goal is to have versioned docs for stable releases (0.23.0, 0.24.0) and development docs that can progress along with the code. This allows us to tailor docs to the next upcoming version as we no longer need to care about diversion between rendered docs and the latest release.

Versions:

  • development (alias: unstable) on each push to the main branch
  • MAJOR.MINOR.PATCH (alias: stable, latest for the newest version)
    • for each "final" release tag
    • for each push to doc maintenance branches: doc/MAJOR.MINOR.PATCH

The default version should the current stable version. The doc maintenance branches may be used to update the version specific documentation when issues arise after a release.

A preview with some fake commits is available: https://nblock.github.io/headscale

  • 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

🔄 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/2265 **Author:** [@nblock](https://github.com/nblock) **Created:** 11/30/2024 **Status:** ✅ Merged **Merged:** 12/2/2024 **Merged by:** [@nblock](https://github.com/nblock) **Base:** `main` ← **Head:** `versioned` --- ### 📝 Commits (1) - [`4bd11a5`](https://github.com/juanfont/headscale/commit/4bd11a5f279a7aca0c5e487d82b39a6df64dfe61) Add versioned documentation ### 📊 Changes **4 files changed** (+53 additions, -52 deletions) <details> <summary>View changed files</summary> ➕ `.github/workflows/docs-deploy.yml` (+48 -0) ➖ `.github/workflows/docs.yml` (+0 -52) 📝 `docs/requirements.txt` (+1 -0) 📝 `mkdocs.yml` (+4 -0) </details> ### 📄 Description Setup mike to provide versioned builds of the documentation. The goal is to have versioned docs for stable releases (0.23.0, 0.24.0) and development docs that can progress along with the code. This allows us to tailor docs to the next upcoming version as we no longer need to care about diversion between rendered docs and the latest release. Versions: * development (alias: unstable) on each push to the main branch * MAJOR.MINOR.PATCH (alias: stable, latest for the newest version) * for each "final" release tag * for each push to doc maintenance branches: doc/MAJOR.MINOR.PATCH The default version should the current stable version. The doc maintenance branches may be used to update the version specific documentation when issues arise after a release. --- A preview with some fake commits is available: https://nblock.github.io/headscale --- - [x] have read the [CONTRIBUTING.md](./CONTRIBUTING.md) file - [x] 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:21:53 +01:00
adam closed this issue 2025-12-29 03:21:53 +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#2576
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?