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.

Sign up for GitHub

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

chore(orgs): Add section for invalid states #1676

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/organizations/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,3 +172,11 @@ If the prebuilt components don't meet your specific needs or if you require more
- [Creating an infinite paginated list of memberships](/docs/organizations/viewing-memberships)
- [Inviting users to an organization](/docs/organizations/inviting-users), which also includes code for creating a custom list of invitations
- [Managing memberships](/docs/organizations/managing-roles), which includes code for updating and deleting a user's membership, for inviting a user, and for creating a custom list of memberships, invitations, and requests

## Invalid states

Organizations can enter invalid states under certain conditions. Here are the common scenarios you should be aware of:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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:

Suggested change
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.
Copy link
Contributor

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.

Suggested change
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.

Loading