-
Notifications
You must be signed in to change notification settings - Fork 468
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
chore(orgs): Add section for invalid states #1676
base: main
Are you sure you want to change the base?
Conversation
Hey, here’s your docs preview: https://clerk.com/docs/pr/1676 |
ce23ba9
to
eb2fa9d
Compare
|
||
## Invalid states | ||
|
||
Organizations can enter invalid states under certain conditions. Here are the common scenarios you should be aware of: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Organizations can enter invalid states under certain conditions. Here are the common scenarios you should be aware of: | |
Organizations can enter invalid states under certain conditions. |
we can either fully omit a second sentence, or have it like this:
Organizations can enter invalid states under certain conditions. Here are the common scenarios you should be aware of: | |
Organizations can enter invalid states under certain conditions. See the following sections for more information. |
I prefer the first.
|
||
### Missing member with elevated permissions | ||
|
||
An organization becomes invalid when it has no members with the following elevated permissions: `org:sys_memberships:read`, `org:sys_memberships:manage`, and `org:sys_profile:delete`. This typically occurs when removing the last admin or downgrading their role. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a nit for readability.
An organization becomes invalid when it has no members with the following elevated permissions: `org:sys_memberships:read`, `org:sys_memberships:manage`, and `org:sys_profile:delete`. This typically occurs when removing the last admin or downgrading their role. | |
An organization becomes invalid when it has no members with the following elevated permissions: `org:sys_memberships:read`, `org:sys_memberships:manage`, and `org:sys_profile:delete`. This typically occurs when the last admin is removed or their role is downgraded. |
@victoriaxyz @alexisintech Sorry for turning this into a draft again. I just want to make sure it isn't going to be merged just yet. This feature is behind a feature flag for testing in staging only, will be publishing the docs once it lands in production. I'll keep you updated! |
Important
🔎 Previews:
Explanation:
This PR:
Resolves ORGS-284
Adds a section to clarify regarding organization invalid states. This could be linked to our upcoming Dashboard changes (https://github.com/clerk/dashboard/pull/3917)