-
Notifications
You must be signed in to change notification settings - Fork 8
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
Registry team access bulk #1047
Conversation
Deploying docs with
|
Latest commit: |
3964c0c
|
Status: | ✅ Deploy successful! |
Preview URL: | https://5187c756.docodile.pages.dev |
Branch Preview URL: | https://registry-team-access-bulk.docodile.pages.dev |
PR ready for tech review. |
|
||
Each user in a registry has a specific *registry role*. Registry roles determine what users can do in a given registry. | ||
|
||
Registry administrators can assign or modify team and user roles in a registry. See [Configure user roles in a registry]({{< relref "configure_registry.md#configure-user-roles-in-a-registry" >}}) for more information. | ||
|
||
{{% alert title="W&B role types" %}} |
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.
Do we have docs on Team roles vs Project roles already? Wondering if that part of the docs describes role assignments in those 2 scopes as role types. If they exist already, it might be better to maintain consistency. Wdyt?
But basically, team roles and registry roles are just different contexts in which users can be assigned roles, and they are independent of each other.
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.
I don't believe we have a doc on team roles vs project roles...
For my own understanding, where can I find more info on this? :)?
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.
I think this covers it in some sense https://docs.wandb.ai/guides/hosting/iam/access-management/restricted-projects/#project-level-roles, but lmk offline if you'd like to sync on it!
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.
lgtm - thank you for the quick response to feedback!
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 44.5%, saving 72.03 KB.
439 images did not require optimisation. |
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.
Some copyedit suggestions and some questions. Please skip anything that isn't helpful!
|
||
1. Navigate to the Registry App at https://wandb.ai/registry/. | ||
2. Select the registry you want to add a user or team to. | ||
3. Click on the gear icon on the upper right hand corner to access the registry settings. |
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.
3. Click on the gear icon on the upper right hand corner to access the registry settings. | |
3. Click the Registry's gear icon on the upper right of the page. |
## Configure the visibility of a custom registry | ||
|
||
A team administrator or registry administrator can assign the visibility of a custom registry during or after the creation of a custom registry. |
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.
A team administrator or registry administrator can assign the visibility of a custom registry during or after the creation of a custom registry. | |
A team administrator or registry administrator can assign the visibility of a custom registry while creating it or afterward. |
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.
Not for this PR, but I'd like to see some of these images more tightly cropped. This one could lose half of its width on the left-hand side and still give enough context on how to move around the UI.
@@ -7,107 +7,121 @@ title: Configure registry access | |||
weight: 3 | |||
--- | |||
|
|||
<!-- A registry, and the linked artifacts inside a registry, belong to an organization. This means that teams within an organization can publish and consume artifacts linked to a registry, if that team has correct access control. --> | |||
Registry admins can [configure registry roles]({{< relref "configure_registry.md#configure-registry-roles" >}}), [add users]({{< relref "configure_registry.md#add-a-user-or-a-team-to-a-registry" >}}), or [remove users]({{< relref "configure_registry.md#remove-a-user-or-team-from-a-registry" >}}) from a registry by configuring the registry's settings. |
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.
Registry admins can [configure registry roles]({{< relref "configure_registry.md#configure-registry-roles" >}}), [add users]({{< relref "configure_registry.md#add-a-user-or-a-team-to-a-registry" >}}), or [remove users]({{< relref "configure_registry.md#remove-a-user-or-team-from-a-registry" >}}) from a registry by configuring the registry's settings. | |
A Registry admin can [configure registry roles]({{< relref "configure_registry.md#configure-registry-roles" >}}), [add users]({{< relref "configure_registry.md#add-a-user-or-a-team-to-a-registry" >}}), and [remove users]({{< relref "configure_registry.md#remove-a-user-or-team-from-a-registry" >}}) from a registry. |
I think it reads better in the singular. I changed the "or" to an "and" because the admin can do all of them. And the following sections show how to do these actions (by modifying the Registry's settings) so I removed that clause. WDYT?
|
||
Registry admins can limit who can access a registry by navigating to a registry's settings and assigning a user's role to [Admin, Member, or Viewer]({{< relref "#registry-roles-permissions" >}}). Users can have different roles in different registries. For example, a user can have a view role in "Registry A" and a member role in the "Registry B". | ||
## Add a user or a team to a registry |
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.
## Add a user or a team to a registry | |
## Add a user or team to a registry |
Registry admins can limit who can access a registry by navigating to a registry's settings and assigning a user's role to [Admin, Member, or Viewer]({{< relref "#registry-roles-permissions" >}}). Users can have different roles in different registries. For example, a user can have a view role in "Registry A" and a member role in the "Registry B". | ||
## Add a user or a team to a registry | ||
|
||
Registry admins can add individual users or entire teams to a registry. To add a user or team to a registry: |
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.
Registry admins can add individual users or entire teams to a registry. To add a user or team to a registry: | |
A Registry admin can add users or teams to a registry: |
4. Navigate to the **Registry access** section. | ||
5. Click on the **Add access** button. |
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.
4. Navigate to the **Registry access** section. | |
5. Click on the **Add access** button. | |
4. In the to the **Registry access** sectio, click **Add access**. |
This reverts commit 1867b27.
Note: This is identical to #1047 Why does this PR exist? I merged [PR 1047](#1047 ) before pushing local changes. Once merged, I could not reopen 1047. So, I am creating this new PR to push all changes in 1047, Registry bulk team access doc. Adds info on how to add a team (in addition to a single user) Moves info about "registry visibility" out of access page so as to not confuse users on registry visibility vs user roles. Adds info on how W&B attempts to resolve role conflicts. --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Registry bulk team access doc.
Ready for tech review. Will ping Docs Team (i.e. Matt) for review when tech review is done or near complete.
Confirm that tests pass and this change is ready for review:
hugo serve
vale ./content