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

Update Managing Owners page with new maintainer role #381

Merged
merged 1 commit into from
Nov 8, 2024
Merged

Update Managing Owners page with new maintainer role #381

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
24 changes: 23 additions & 1 deletion managing-owners-using-ui.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ You will be able to see the confirmation status, MFA level and the user who auth
Adding user as an owner to your gem
--------------------------------
Step: 1
Enter the email or handle of the user in the text field labels *Email/Handle* and click *Add Owner*.
Enter the email or handle of the user in the text field labels *Email/Handle*
Select the role that best suits the user, see [Owner & Maintainer Roles](#owner--maintainer-roles) for more details.
Finally, click *Add Owner*.

Step: 2
The user added as an owner will be sent an email with a link to confirm the ownership.
Expand All @@ -36,6 +38,26 @@ On confirmation, all the existing owners will be notified about the owner additi

`Note that` the user won't have access to the gem until they confirm the ownership addition.

Owner & Maintainer Roles
------------------------
When managing owners, you have the option to select a role, either Owner or Maintainer. Owners have full control over the gem, including the ability to add or remove owners. Maintainers, have the ability to publish and yank gem versions, but cannot manager users, or configure gem security settings.
colby-swandale marked this conversation as resolved.
Show resolved Hide resolved

Owners & Maintainers have access to the following permissions:

| Permission | Owner | Maintainer |
|:--------------------------------------:|:-----:|:----------:|
| Can publish new gem versions | ✅ | ✅ |
| Can yank gem versions | ✅ | ✅ |
| Can add or remove owners | ✅ | ❌ |
| Configure OIDC and Trusted Publishing | ✅ | ❌ |
| Manage gem adoptions | ✅ | ❌ |


Updating an owner role
----------------------
To update the role of an owner, visit `https://rubygems.org/gems/<gem-name>/owners` and click on the *Edit* button of the
corresponding user. You can select the role of the user edit page and click on *Update Owner*.

Resend ownership confirmation link
----------------------------------
In case you weren't able to confirm the ownership within 48 hours,
Expand Down
Loading