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: Add role-based permissions tutorial #894

Conversation

robertjdominguez
Copy link
Collaborator

@robertjdominguez robertjdominguez commented Feb 12, 2025

Description 📝

Adds a role-based permissions tutorial after questions from users in Discord came through. This illustrates how to limit command execution based on a relationship (e.g., an author can only update their own posts).

Quick Links 🚀

New tutorial

Assertion Tests 🤖

A user should be able to add role-based permissions to limit command execution in their API.

@hasura-bot
Copy link
Contributor

hasura-bot commented Feb 12, 2025

DX: Assertion Testing

✅ Diff

The contribution is well-structured with a clear heading, introduction, step-by-step tutorial, and wrapping up section that explains the context and content of changes. Code snippets are properly formatted, and appropriate titles provide clarity. The prerequisites section sets a good foundation for the reader before diving into the tutorial. The examples provided are easy to understand and follow. The use of comments in the code to clarify the purpose of code sections is helpful.

✅ Integrated

The PR integrates smoothly with the rest of the documentation. It fits into the ordered tutorials, adding a valuable piece on role-based permissions, specifically on restricting command execution. The documentation structure benefits from this addition as it continues the logical sequence of tutorials and improves the depth of the authorization topic. The update to the index.mdx file ensures that the new tutorial is appropriately referenced within the overall structure, maintaining ease of navigation for the user.

@hasura-bot
Copy link
Contributor

@robertjdominguez Thanks for your PR! I've assigned @robertjdominguez to review it.

@robertjdominguez robertjdominguez force-pushed the robdominguez/doc-2420-add-recipe-for-relationships-in-command-permissions branch from b7ce315 to 37aab6f Compare February 12, 2025 21:56
Copy link

cloudflare-workers-and-pages bot commented Feb 12, 2025

Deploying ddn-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: bd6abdd
Status:⚡️  Build in progress...

View logs

Tweaks the language a bit after re-reading it with fresh eyes.
Copy link
Collaborator

@seanparkross seanparkross left a comment

Choose a reason for hiding this comment

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

Gorgeous.

@robertjdominguez robertjdominguez enabled auto-merge (squash) February 17, 2025 13:36
@robertjdominguez robertjdominguez merged commit e75be19 into main Feb 17, 2025
3 of 4 checks passed
@robertjdominguez robertjdominguez deleted the robdominguez/doc-2420-add-recipe-for-relationships-in-command-permissions branch February 17, 2025 13:40
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.

3 participants