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 #1994] [CLOSED] Properly render ACL in documentation #2437

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

📋 Pull Request Information

Original PR: https://github.com/juanfont/headscale/pull/1994
Author: @lkiesow
Created: 6/25/2024
Status: ❌ Closed

Base: main ← Head: patch-1

📝 Commits (1)

  • 2604234 Properly render ACL in documentation

📊 Changes

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

View changed files

📝 docs/acls.md (+1 -1)

📄 Description

The ACL example in the documentation specifies the highlighting as JSON, but it has comments which causes GitHub to render them as errors. Comments are allowed in the JSON5 extension, however, to which this patch switches.

Here is how this looks before and after the change:

Screenshot from 2024-06-25 09-57-51

  • 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
    • Updated code block formatting in the documentation to use json5, enhancing syntax flexibility for code snippets.

🔄 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/1994 **Author:** [@lkiesow](https://github.com/lkiesow) **Created:** 6/25/2024 **Status:** ❌ Closed **Base:** `main` ← **Head:** `patch-1` --- ### 📝 Commits (1) - [`2604234`](https://github.com/juanfont/headscale/commit/2604234bc0a072e9eba68c3d3a0c3e3294375e9e) Properly render ACL in documentation ### 📊 Changes **1 file changed** (+1 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `docs/acls.md` (+1 -1) </details> ### 📄 Description The ACL example in the documentation specifies the highlighting as JSON, but it has comments which causes GitHub to render them as errors. Comments are allowed in the JSON5 extension, however, to which this patch switches. Here is how this looks before and after the change: ![Screenshot from 2024-06-25 09-57-51](https://github.com/juanfont/headscale/assets/1008395/0eddd677-1bee-4abc-8c8c-f816781ec3ef) <!-- 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… --> - [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 <!-- If applicable, please reference the issue using `Fixes #XXX` and add tests to cover your new code. --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Updated code block formatting in the documentation to use `json5`, enhancing syntax flexibility for code snippets. <!-- 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:17 +01:00
adam closed this issue 2025-12-29 03:21:17 +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#2437
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?