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 #2380] [CLOSED] Spell check and updating docs #2634

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

📋 Pull Request Information

Original PR: https://github.com/juanfont/headscale/pull/2380
Author: @Nbelles
Created: 1/26/2025
Status: ❌ Closed

Base: main ← Head: main

📝 Commits (4)

📊 Changes

20 files changed (+30 additions, -30 deletions)

View changed files

📝 CHANGELOG.md (+1 -1)
📝 docs/about/clients.md (+1 -1)
📝 hscontrol/db/db.go (+3 -3)
📝 hscontrol/notifier/notifier.go (+1 -1)
📝 hscontrol/notifier/notifier_test.go (+1 -1)
📝 hscontrol/policy/acls.go (+4 -4)
📝 hscontrol/poll.go (+2 -2)
📝 hscontrol/types/node.go (+2 -2)
📝 hscontrol/util/dns.go (+1 -1)
📝 integration/acl_test.go (+1 -1)
📝 integration/auth_oidc_test.go (+1 -1)
📝 integration/cli_test.go (+1 -1)
📝 integration/dns_test.go (+1 -1)
📝 integration/dockertestutil/network.go (+1 -1)
📝 integration/dsic/dsic.go (+2 -2)
📝 integration/hsic/config.go (+1 -1)
📝 integration/hsic/hsic.go (+2 -2)
📝 integration/ssh_test.go (+1 -1)
📝 integration/tsic/tsic.go (+2 -2)
📝 integration/utils.go (+1 -1)

📄 Description

  • 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

I noticed a slight inconsistency in the public docs (the /windows and /apple pages were referenced but not /android) and I figured while I was making this PR that I might as well do a quick spell check across the codebase. Most everything was updating spelling in comments.

There is one actual code change in an integration test (/integration/cli_test.go) that had a string that had a typo in it. That is probably the only thing that could use a pair of eyes from an actual codebase developer to make sure that doesn't break anything.

Thanks!

🔄 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/2380 **Author:** [@Nbelles](https://github.com/Nbelles) **Created:** 1/26/2025 **Status:** ❌ Closed **Base:** `main` ← **Head:** `main` --- ### 📝 Commits (4) - [`7299e59`](https://github.com/juanfont/headscale/commit/7299e5919a551bad8d5a47ab80561cad7430be4e) Spell check - [`0cf5059`](https://github.com/juanfont/headscale/commit/0cf5059748e3e72ae39b2ce4e8030bb611cc3dd0) Updating docs - [`b720e48`](https://github.com/juanfont/headscale/commit/b720e48cd46a68dcddb11444aa813ffb60da25a1) Reverting documentation change - [`462326f`](https://github.com/juanfont/headscale/commit/462326fd005922db1798812fb6e075af3da07411) Fixing unknown action ### 📊 Changes **20 files changed** (+30 additions, -30 deletions) <details> <summary>View changed files</summary> 📝 `CHANGELOG.md` (+1 -1) 📝 `docs/about/clients.md` (+1 -1) 📝 `hscontrol/db/db.go` (+3 -3) 📝 `hscontrol/notifier/notifier.go` (+1 -1) 📝 `hscontrol/notifier/notifier_test.go` (+1 -1) 📝 `hscontrol/policy/acls.go` (+4 -4) 📝 `hscontrol/poll.go` (+2 -2) 📝 `hscontrol/types/node.go` (+2 -2) 📝 `hscontrol/util/dns.go` (+1 -1) 📝 `integration/acl_test.go` (+1 -1) 📝 `integration/auth_oidc_test.go` (+1 -1) 📝 `integration/cli_test.go` (+1 -1) 📝 `integration/dns_test.go` (+1 -1) 📝 `integration/dockertestutil/network.go` (+1 -1) 📝 `integration/dsic/dsic.go` (+2 -2) 📝 `integration/hsic/config.go` (+1 -1) 📝 `integration/hsic/hsic.go` (+2 -2) 📝 `integration/ssh_test.go` (+1 -1) 📝 `integration/tsic/tsic.go` (+2 -2) 📝 `integration/utils.go` (+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. --> <!-- Please tick if the following things apply. You… --> - [ ] have read the [CONTRIBUTING.md](./CONTRIBUTING.md) file - [ ] raised a GitHub issue or discussed it on the projects chat beforehand - [ ] added unit tests - [~] added integration tests - [X] updated documentation if needed - [X] updated CHANGELOG.md <!-- If applicable, please reference the issue using `Fixes #XXX` and add tests to cover your new code. --> I noticed a slight inconsistency in the public docs (the `/windows` and `/apple` pages were referenced but not `/android`) and I figured while I was making this PR that I might as well do a quick spell check across the codebase. Most everything was updating spelling in comments. There is one actual code change in an integration test (`/integration/cli_test.go`) that had a string that had a typo in it. That is probably the only thing that could use a pair of eyes from an actual codebase developer to make sure that doesn't break anything. Thanks! --- <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:22:08 +01:00
adam closed this issue 2025-12-29 03:22:08 +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#2634
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?