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

feat: add project-level permissions docs #27887

Merged
merged 6 commits into from
Jul 17, 2024
Merged

Conversation

w3b6x9
Copy link
Member

@w3b6x9 w3b6x9 commented Jul 10, 2024

I have read the CONTRIBUTING.md file.

YES

What kind of change does this PR introduce?

docs update

What is the new behavior?

org and project level permissions corresponding to roles

Additional context

Screenshot 2024-07-09 at 20 08 27

Copy link

vercel bot commented Jul 10, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 17, 2024 9:51am
5 Skipped Deployments
Name Status Preview Comments Updated (UTC)
design-system ⬜️ Ignored (Inspect) Visit Preview Jul 17, 2024 9:51am
studio ⬜️ Ignored (Inspect) Visit Preview Jul 17, 2024 9:51am
studio-self-hosted ⬜️ Ignored (Inspect) Visit Preview Jul 17, 2024 9:51am
studio-staging ⬜️ Ignored (Inspect) Visit Preview Jul 17, 2024 9:51am
zone-www-dot-com ⬜️ Ignored (Inspect) Visit Preview Jul 17, 2024 9:51am

Copy link

supabase bot commented Jul 10, 2024

No changes detected in supabase directory.
This pull request has been ignored for the connected project xguihxuzqibwxjnimxev due to its connection settings.
Go to Project Integrations Settings ↗︎ in order to change this behavior.


Branching Preview Branches by Supabase.
Learn more about Supabase for Git ↗︎.

@joshenlim
Copy link
Member

Just a nit - i'm wondering if we can save these permissions into the shared-types repo actually, cause the dashboard also has a UI showcasing all the perms - will be ideal to have one source of truth and dashboard can then render the perms based on that instead if hard coding

@w3b6x9

This comment was marked as resolved.

Copy link
Contributor

@charislam charislam left a comment

Choose a reason for hiding this comment

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

Checked build and looks good, I'll leave it to someone familiar with the intended permissions system to double-check the matrix

@joshenlim
Copy link
Member

joshenlim commented Jul 12, 2024

cc @inian i think the matrices here are all okay with explaining the permissions for org level functionality and project level functionality

but should we add another section to explain assigning roles on the organization vs assign roles on projects? (and also explain that project roles are available as part of the enterprise plan)

what i have in mind is like talking about

  • If a user is assigned a role on the organization, the user will also have the equivalent permissions for that role across all projects under the organization (Refer to "Project permissions across roles" table)
  • If you're looking to only allow access to specific projects for a user, then reach out to success to chat about enterprise or something

@MildTomato
Copy link
Contributor

MildTomato commented Jul 12, 2024

Screenshot 2024-07-12 at 1 43 18 PM

I came to this PR to check the upcoming docs for project granular role assignment, and it's not clear reading this. I quickly read it a few times and I nearly commented saying we haven't even mentioned it; however, it the opening lines do tease you that it might be possible.

Shouldn't we have a section with it's own header explaining you can assign roles per project vs org?

edit - noticed @joshenlim said the same thing above

@w3b6x9
Copy link
Member Author

w3b6x9 commented Jul 13, 2024

Shouldn't we have a section with it's own header explaining you can assign roles per project vs org?

@MildTomato yes that's the missing piece and that's been passed back to Joshen and Hieu.

@w3b6x9
Copy link
Member Author

w3b6x9 commented Jul 13, 2024

but should we add another section to explain assigning roles on the organization vs assign roles on projects? (and also explain that project roles are available as part of the enterprise plan)

what i have in mind is like talking about

  • If a user is assigned a role on the organization, the user will also have the equivalent permissions for that role across all projects under the organization (Refer to "Project permissions across roles" table)
  • If you're looking to only allow access to specific projects for a user, then reach out to success to chat about enterprise or something

@joshenlim yes this is the missing piece to the docs that need to be added. what you had in mind sounds great. can we also add in the piece that's like if a member has a project-level role then they no longer have a role at the org-level. that was unclear to me when looking at the project.

apps/docs/content/guides/platform/access-control.mdx Outdated Show resolved Hide resolved
apps/docs/content/guides/platform/access-control.mdx Outdated Show resolved Hide resolved
apps/docs/content/guides/platform/access-control.mdx Outdated Show resolved Hide resolved
apps/docs/content/guides/platform/access-control.mdx Outdated Show resolved Hide resolved
apps/docs/content/guides/platform/access-control.mdx Outdated Show resolved Hide resolved
apps/docs/content/guides/platform/access-control.mdx Outdated Show resolved Hide resolved
apps/docs/content/guides/platform/access-control.mdx Outdated Show resolved Hide resolved
apps/docs/content/guides/platform/access-control.mdx Outdated Show resolved Hide resolved
@joshenlim joshenlim merged commit 986ab12 into master Jul 17, 2024
13 of 14 checks passed
@joshenlim joshenlim deleted the fix/project-level-perms branch July 17, 2024 09:53
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.

None yet

5 participants