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.

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

docs: make cross entities beta feature #1801

Merged
merged 1 commit into from
Nov 21, 2024
Merged

docs: make cross entities beta feature #1801

merged 1 commit into from
Nov 21, 2024

Conversation

EgeAytin
Copy link
Member

@EgeAytin EgeAytin commented Nov 21, 2024

docs: make cross entities beta feature

Summary by CodeRabbit

  • Documentation
    • Restructured and enhanced the guide on modeling authorization in Permify.
    • Introduced new sections on Permify Schema, Developing a Schema, Defining Entities, Defining Relations, Defining Permissions, and Attribute Based Access Control (ABAC).
    • Expanded explanations and examples for user roles, relationships, and permission structures to improve clarity and usability.

Copy link

coderabbitai bot commented Nov 21, 2024

Walkthrough

The pull request introduces significant restructuring and content enhancements to the modeling.mdx document within the documentation for Permify. Key updates include the addition of new sections that clarify the Permify Schema, entity definitions, relations, permissions, and the introduction of Attribute Based Access Control (ABAC). The document now provides a more comprehensive guide for users to develop and implement authorization schemas, with detailed examples and recommendations for aligning entity names with database tables.

Changes

File Path Change Summary
docs/getting-started/modeling.mdx - Added sections on Permify Schema, Developing a Schema, Defining Entities, Defining Relations,
Defining Permissions, Attribute Based Permissions (ABAC), Modeling Guides, and More Comprehensive Examples.

Possibly related PRs

  • docs: update modeling section for DSL expression confusion #1677: The changes in this PR also involve the docs/getting-started/modeling.mdx file, focusing on clarifying the modeling section and enhancing the explanation of permissions, which aligns with the main PR's restructuring and content enhancement regarding the modeling of authorization.

🐇 In the land of code where the schemas grow,
A tale of permissions begins to flow.
With entities defined and relations in sight,
ABAC joins in, making access just right.
So hop through the docs, let the knowledge expand,
For in the world of Permify, we take a stand! 🌟


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.

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.

Copy link

@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: 0

🧹 Outside diff range and nitpick comments (1)
docs/getting-started/modeling.mdx (1)

383-386: Enhance the beta feature notice with more specific details

The beta notice could be more informative and actionable. Consider:

  1. Explicitly mentioning "Cross-entity attributes" as the beta feature
  2. Providing specific contact methods for requesting early access (e.g., Discord link, email, or GitHub issue)
 <Info>
-This feature is currently in beta and available upon request. Let us know, and we'll give you early access!
+Cross-entity attributes feature is currently in beta and available upon request. Join our [Discord](https://discord.gg/n6KfzYxhPp) or open a [GitHub issue](https://github.com/Permify/permify/issues/new) to request early access!
 </Info>
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1eb6e01 and 6aa7d91.

📒 Files selected for processing (1)
  • docs/getting-started/modeling.mdx (1 hunks)
🔇 Additional comments (1)
docs/getting-started/modeling.mdx (1)

Line range hint 387-456: LGTM! Clear and well-structured documentation

The cross-entity attributes documentation is well-written with:

  • Clear explanation of the feature
  • Practical example demonstrating real-world usage
  • Proper code formatting and comments

@EgeAytin EgeAytin merged commit ac3c197 into master Nov 21, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant