[PR #2100] [MERGED] Move flags after the command #2495

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

📋 Pull Request Information

Original PR: https://github.com/juanfont/headscale/pull/2100
Author: @nblock
Created: 9/4/2024
Status: Merged
Merged: 9/4/2024
Merged by: @kradalby

Base: mainHead: flags


📝 Commits (1)

  • 954a0a7 Move flags after the command

📊 Changes

5 files changed (+10 additions, -10 deletions)

View changed files

📝 docs/running-headscale-container.md (+2 -2)
📝 docs/running-headscale-linux-manual.md (+2 -2)
📝 docs/running-headscale-linux.md (+2 -2)
📝 docs/running-headscale-openbsd.md (+2 -2)
📝 docs/running-headscale-sealos.md (+2 -2)

📄 Description

The built-in help also shows flags to given after the command. Align documentation examples accordingly.

  • 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

Summary by CodeRabbit

  • Documentation
    • Simplified command syntax for registering machines and creating pre-authenticated keys in the headscale documentation, enhancing clarity and usability.
    • Removed redundant headscale prefix in command examples, aligning with common command-line conventions.

🔄 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/2100 **Author:** [@nblock](https://github.com/nblock) **Created:** 9/4/2024 **Status:** ✅ Merged **Merged:** 9/4/2024 **Merged by:** [@kradalby](https://github.com/kradalby) **Base:** `main` ← **Head:** `flags` --- ### 📝 Commits (1) - [`954a0a7`](https://github.com/juanfont/headscale/commit/954a0a7750b21cac05ff56abf1ed3f9ccbd57ffe) Move flags after the command ### 📊 Changes **5 files changed** (+10 additions, -10 deletions) <details> <summary>View changed files</summary> 📝 `docs/running-headscale-container.md` (+2 -2) 📝 `docs/running-headscale-linux-manual.md` (+2 -2) 📝 `docs/running-headscale-linux.md` (+2 -2) 📝 `docs/running-headscale-openbsd.md` (+2 -2) 📝 `docs/running-headscale-sealos.md` (+2 -2) </details> ### 📄 Description The built-in help also shows flags to given after the command. Align documentation examples accordingly. - [x] 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 - [ ] updated CHANGELOG.md <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Simplified command syntax for registering machines and creating pre-authenticated keys in the `headscale` documentation, enhancing clarity and usability. - Removed redundant `headscale` prefix in command examples, aligning with common command-line conventions. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --- <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:32 +01:00
adam closed this issue 2025-12-29 03:21:32 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/headscale#2495