Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove references to tests/acls from the documentation #2088

Merged
merged 1 commit into from
Sep 1, 2024
Merged

Remove references to tests/acls from the documentation #2088

merged 1 commit into from
Sep 1, 2024

Conversation

nblock
Copy link
Collaborator

@nblock nblock commented Aug 30, 2024 •
edited by coderabbitai bot
Loading

The ACL test files got removed with 2d365c8

  • 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
    • Improved clarity and conciseness of the ACLs documentation by removing redundant phrases and simplifying instructions.

@nblock nblock requested a review from ohdearaugustin as a code owner August 30, 2024 08:46
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 30, 2024 •
edited
Loading

Walkthrough

The document underwent refinements to enhance clarity by simplifying language and removing redundant phrases. References to specific test directories were streamlined to focus solely on the Tailscale link, maintaining the emphasis on the required ACL format while eliminating distractions.

Changes

Files Change Summary
docs/acls.md Refined language and removed redundant phrases to enhance clarity; focused on Tailscale link only.

Poem

In the meadow, changes bloom,
Clarity dances, dispelling gloom.
With each word, a clearer path,
Simplified guidance, a joyful laugh.
Hoppy hearts rejoice in cheer,
For documentation's bright frontier! 🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot]
coderabbitai bot reviewed Aug 30, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fffd9d7 and 40e39e8.

Files selected for processing (1)
  • docs/acls.md (2 hunks)
Additional context used
Markdownlint
docs/acls.md

6-6: null
Bare URL used

(MD034, no-bare-urls)

Additional comments not posted (1)
docs/acls.md (1)

46-46: Documentation streamlined successfully.

The removal of the local test ACL reference and the focus on the huJSON link simplifies and clarifies the documentation, aligning with the PR's objectives.

The code changes are approved.

docs/acls.md
@@ -3,7 +3,7 @@ Headscale implements the same policy ACLs as Tailscale.com, adapted to the self-
For instance, instead of referring to users when defining groups you must
use users (which are the equivalent to user/logins in Tailscale.com).

Please check https://tailscale.com/kb/1018/acls/, and `./tests/acls/` in this repo for working examples.
Please check https://tailscale.com/kb/1018/acls/ for further information.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Improve URL presentation.

The bare URL could be enhanced by making it a clickable link, which would improve the user experience and adhere to best practices in markdown documentation.

Consider modifying the URL to a markdown link format:

Please check [Tailscale ACLs](https://tailscale.com/kb/1018/acls/) for further information.
Tools
Markdownlint

6-6: null
Bare URL used

(MD034, no-bare-urls)

@kradalby kradalby enabled auto-merge (squash) September 1, 2024 13:06
@kradalby kradalby merged commit ed71d23 into juanfont:main Sep 1, 2024
111 checks passed
@nblock nblock deleted the docs-no-tests-acl branch October 8, 2024 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@kradalby kradalby kradalby approved these changes

@ohdearaugustin ohdearaugustin Awaiting requested review from ohdearaugustin ohdearaugustin is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nblock @kradalby