Skip to content

Commit 10da769

Browse files
tomarradawn-ducky
andauthored
feat: update orgs page with RBAC updates (#476)
* feat: update orgs page with RBAC updates * spelling fix * Clarify description of organizations Removed 'groups of' for clarity in the description of organizations. * formatting changes --------- Co-authored-by: dawn-ducky <[email protected]>
1 parent 363b3e0 commit 10da769

File tree

1 file changed

+74
-112
lines changed

1 file changed

+74
-112
lines changed

src/content/docs/account/orgs.mdx

Lines changed: 74 additions & 112 deletions
Original file line numberDiff line numberDiff line change
@@ -13,39 +13,25 @@ import completedAddMemberToOrg from '~/assets/completed_add_member_to_org.png';
1313
import transferAppToDifferentOrg from '~/assets/transfer_app_to_different_org.png';
1414
import initWithOrg from '~/assets/init_with_org.png';
1515

16-
Shorebird's Pro tier unlocks new features for collaborating with your peers
17-
including:
16+
Organizations are a way share groups of apps with people. This is useful for any
17+
team collaborating across a company to have access as needed to releases,
18+
patches, and more.
1819

19-
- Creating unlimited organizations
20-
- Adding unlimited members to your organizations
21-
- Managing roles for your organization members
22-
- Adding unlimited collaborators to an individual app
23-
- Managing roles for your app collaborators
20+
## Account Requirements
2421

25-
Shorebird free "Hobby" users can upgrade to the Pro tier to add these features
22+
Shorebird's paid plans unlocks features for collaborating with your peers.
23+
Shorebird free plan users can upgrade to a paid plan to access these features
2624
via the account settings page in the
2725
[Shorebird console](https://console.shorebird.dev/account).
2826

29-
## Upgrading to Pro
30-
31-
You can manage your account and billing at any time via
32-
https://console.shorebird.dev/account
33-
34-
There is an "Edit" drop-down there, and from within that an "Upgrade Account"
35-
option which will present you a pop-up dialog and allow you to upgrade to the
36-
"Pro" plan.
37-
3827
If you do not see the plan you're expecting, please reach out to
39-
[email protected] we'd be happy to work with you.
40-
41-
Once you've upgraded to the Pro plan, you have the ability to use the above
42-
features.
28+
[email protected] we'd be happy help you.
4329

4430
## Creating an Organization
4531

46-
Organizations are a way share groups of apps with groups of people. To create an
47-
organization, visit the Shorebird console and click the account dropdown in the
48-
top left corner. From there, click the "+" button next to "Organizations".
32+
To create an organization, visit the Shorebird console and click the account
33+
dropdown in the top left corner. From there, click the "+" button next to
34+
"Organizations".
4935

5036
<Image
5137
src={createOrg}
@@ -61,29 +47,23 @@ including the name.
6147
alt="Screenshot of how to get to Organization settings in the Shorebird Console"
6248
/>
6349

64-
## Managing Organization Members
50+
## Managing Apps
6551

66-
To add one or more members to your organization, visit the organization's
67-
settings and click the "Add member" button.
52+
Organizations can have multiple apps associated with them. You can either
53+
transfer existing apps to an organization or create new apps within the
54+
organization directly.
6855

69-
<Image
70-
src={addMemberToOrg}
71-
alt="Screenshot of how to get to add a member to an Organization in the Shorebird Console"
72-
/>
56+
### Create a New App
7357

74-
You can also edit a member's role or remove them from the organization from the
75-
same organization settings page.
58+
To create a new app within an organization, select the organization when running
59+
`shorebird init`:
7660

7761
<Image
78-
src={completedAddMemberToOrg}
79-
alt="Screenshot of successfully adding a member to an Organization in the Shorebird Console"
62+
src={initWithOrg}
63+
alt="Screenshot of doing `shorebird init` command and selecting an organization"
8064
/>
8165

82-
## Managing Organization Apps
83-
84-
Organizations can have multiple apps associated with them. You can either
85-
transfer existing apps to an organization or create new apps within the
86-
organization directly.
66+
### Transfer an App
8767

8868
To transfer an existing app to an organization, visit the app's settings and
8969
click the "Transfer app" button. You can then select the organization you want
@@ -94,59 +74,81 @@ to transfer the app to from the dropdown.
9474
alt="Screenshot of dialog for transferring app to a different org in the Shorebird Console"
9575
/>
9676

97-
To create a new app within an organization, select the organization when running
98-
`shorebird init`:
77+
## Managing Members
78+
79+
### Add a Member
80+
81+
To add one or more members to your organization, visit the organization's
82+
settings and click the "Add member" button.
9983

10084
<Image
101-
src={initWithOrg}
102-
alt="Screenshot of doing `shorebird init` command and selecting an organization"
85+
src={addMemberToOrg}
86+
alt="Screenshot of how to get to add a member to an Organization in the Shorebird Console"
10387
/>
10488

105-
## Organization Roles
89+
You can also edit a member's role or remove them from the organization from the
90+
same organization settings page.
10691

107-
Organization roles apply to all apps within the organization and can be managed
108-
via the organization settings page in the Shorebird console.
92+
<Image
93+
src={completedAddMemberToOrg}
94+
alt="Screenshot of successfully adding a member to an Organization in the Shorebird Console"
95+
/>
10996

110-
If you have any questions about access control for your app, please do not
111-
hesitate to reach out to [email protected].
97+
### Remove a Member
11298

113-
### Organization Member
99+
You can easily remove a member from an organization via the organizations
100+
settings page. Locate the member you wish to remove, click the Trash icon, and
101+
confirm the action.
102+
103+
## Member Roles
104+
105+
Organization roles apply to all apps within the organization and can be managed
106+
via the organization settings page in the Shorebird console. The roles available
107+
to you are based on the plan that you have.
114108

115-
New members added to an organization are assigned the "Member" role by default.
109+
| | Free | Pro | Business | Enterprise |
110+
| ----------- | ---- | --- | -------- | ---------- |
111+
| Viewer | | |||
112+
| Developer | ||||
113+
| App Manager | | | ||
114+
| Admin | ||||
115+
| Owner | ||||
116116

117-
Members can:
117+
### Viewer
118118

119-
- Read information for all apps within the organization
120-
- View collaborators on all apps within the organization
121-
- Create releases and patches for all apps within the organization
122-
- View insights for all apps within the organization
119+
Read-only access for stakeholders who need visibility into apps, releases, and
120+
patches without the ability to make changes. Ideal for product managers, QA,
121+
support, or leadership teams.
123122

124-
### Organization Admin
123+
### Developer
125124

126-
Organization Admins can:
125+
Hands-on role for engineers actively building and shipping apps. Can create
126+
releases and patches, promote patches, and manage day-to-day development
127+
workflows without administrative access.
127128

128-
- Do everything a Member can do
129-
- Add and Remove Members for the organization
130-
- Delete Apps within the organization
131-
- Delete Releases within the organization
129+
### App Manager
132130

133-
### Organization Owner
131+
Responsible for managing application lifecycle and release strategy. Has all
132+
Developer capabilities plus elevated control over app-level configuration,
133+
environments, and release coordination.
134134

135-
There is only one owner per organization (the person who created the
136-
organization) and they have full control over the organization and all apps
137-
within it.
135+
### Admin
138136

139-
The owner can:
137+
Administrative role for managing team access and organization-level settings.
138+
Can configure apps, manage users and roles, and handle most operational tasks,
139+
excluding billing and plan changes.
140140

141-
- Do everything an Admin can do
142-
- Manage the billing information for the organization
141+
### Owner
143142

144-
If you need more control or custom roles, consider our
145-
[enterprise plan](https://shorebird.dev/pricing).
143+
Full control over the organization. Can manage billing and plans, ownership
144+
settings, and all platform capabilities. Intended for primary account holders.
146145

147-
## Managing Collaborators
146+
## Managing Per App Collaborators
148147

149148
Per app collaborators can also be added and managed via the Shorebird console.
149+
The same management and permissions structure of organizations applies to
150+
collaborators, just at a per app level.
151+
150152
To add a collaborator, from your app's page:
151153

152154
1. Select the "Collaborators" tab.
@@ -159,43 +161,3 @@ To add a collaborator, from your app's page:
159161

160162
Existing collaborators can be removed by clicking the trash icon next to their
161163
email address.
162-
163-
## Collaborator Roles
164-
165-
Collaborators are used for per-app access controls. Typically used to provide
166-
someone temporary access to only one of your applications.
167-
168-
Collaborators allow you to provide access to one of your apps without granting
169-
someone access to all of the apps in an organization.
170-
171-
Collaborators can be added both to apps within your personal account as well as
172-
on any organization which you are a member of.
173-
174-
Collaborators can see the existence of an organization and its name, but cannot
175-
see any other aspects of an organization.
176-
177-
### App Developer
178-
179-
The Developer role can:
180-
181-
- Read information for a single app
182-
- View collaborators on that app
183-
- Create releases and patches for that app
184-
- View insights for that app
185-
186-
Developers can be added and removed by any Admin, see below.
187-
188-
### App Admin
189-
190-
The Admin role can:
191-
192-
- Do everything a Developer can do
193-
- Add and Remove Developers for an App
194-
- Delete Apps
195-
- Delete Releases
196-
197-
## Transferring Ownership
198-
199-
The easiest way to transfer app ownership is to have the desired owner create an
200-
organization and add the current owner to the organization. The current owner
201-
can then transfer the app to the organization.

0 commit comments

Comments
 (0)