Docs: Update ACLs on file formats

[Haarolean]

Updated docs on ACLs according to the comment on YAML deprecation

By the way, the 'tests' link is broken and I couldn't find the files this link should mention. Any clues?

• 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 Access Control Lists (ACLs) documentation to specify that only huJSON format is accepted, removing the previous YAML option.

[coderabbitai]

Walkthrough

The documentation for Access Control Lists (ACLs) has been revised to specify that ACLs must be written exclusively in huJSON format. This update eliminates the previous option of using YAML, clarifying the required format and ensuring that users are aware of the mandatory use of huJSON. The reference to test ACLs remains unchanged, but the emphasis on format has shifted from optional to mandatory.

Changes

Files	Change Summary
docs/acls.md	Updated to specify that ACLs must be written in huJSON format, removing YAML as an option.

Poem

In the land of code, where rabbits roam,
A change was made to call ACLs home.
With huJSON we now play,
No YAML in our way!
Hopping through docs, we cheer and say,
"Format's clear as day!" 🐇✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9bed76d and a7ef2b7.

Files selected for processing (1)

• docs/acls.md (1 hunks)

Additional comments not posted (1)

docs/acls.md (1)

46-46: Verify the link to test ACLs.

The documentation specifies that ACLs must be written in huJSON format, which is clear. However, ensure that the link to the test ACLs is correct and accessible.

Run the following script to verify the existence of the referenced directory: