[PR #1618] [MERGED] Docs: Update running-headscale-container.md - fix link to example config #2215

Closed
opened 2025-12-29 03:20:15 +01:00 by adam · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/juanfont/headscale/pull/1618
Author: @jessebot
Created: 11/27/2023
Status: Merged
Merged: 11/29/2023
Merged by: @kradalby

Base: mainHead: patch-1


📝 Commits (1)

  • 296df61 Docs: Update running-headscale-container.md - fix link to example config

📊 Changes

1 file changed (+1 additions, -1 deletions)

View changed files

📝 docs/running-headscale-container.md (+1 -1)

📄 Description

Description

This should just be simple update to fix this link in the containers docs for the example config, as right now it shows up as:

Download a copy of the [example configuration]config-example.yaml from the headscale repository.

This should fix to look like this:

Download a copy of the example configuration from the headscale repository.

Checklist

  • 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/1618 **Author:** [@jessebot](https://github.com/jessebot) **Created:** 11/27/2023 **Status:** ✅ Merged **Merged:** 11/29/2023 **Merged by:** [@kradalby](https://github.com/kradalby) **Base:** `main` ← **Head:** `patch-1` --- ### 📝 Commits (1) - [`296df61`](https://github.com/juanfont/headscale/commit/296df617f52d626e76ec424e223d72eed306f7f6) Docs: Update running-headscale-container.md - fix link to example config ### 📊 Changes **1 file changed** (+1 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `docs/running-headscale-container.md` (+1 -1) </details> ### 📄 Description <!-- Headscale is "Open Source, acknowledged contribution", this means that any contribution will have to be discussed with the Maintainers before being submitted. This model has been chosen to reduce the risk of burnout by limiting the maintenance overhead of reviewing and validating third-party code. Headscale is open to code contributions for bug fixes without discussion. If you find mistakes in the documentation, please submit a fix to the documentation. --> ## Description This should just be simple update to fix this link in the [containers docs](https://headscale.net/running-headscale-container/#configure-and-run-headscale) for the example config, as right now it shows up as: > Download a copy of the [example configuration][config-example.yaml](https://github.com/juanfont/headscale/blob/main/config-example.yaml) from the headscale repository. This should fix to look like this: > Download a copy of the [example configuration](https://github.com/juanfont/headscale/blob/main/config-example.yaml) from the headscale repository. <!-- Please tick if the following things apply. You… --> ## Checklist - [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 <!-- If applicable, please reference the issue using `Fixes #XXX` and add tests to cover your new code. --> --- <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:20:15 +01:00
adam closed this issue 2025-12-29 03:20:15 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/headscale#2215