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.

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

Merged
merged 16 commits into from
Feb 11, 2025
Merged

Registry team access bulk #1047

merged 16 commits into from
Feb 11, 2025

Conversation

ngrayluna
Copy link
Contributor

@ngrayluna ngrayluna commented Jan 30, 2025

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.

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:

  • Local hugo serve
  • Local vale ./content

Copy link

cloudflare-workers-and-pages bot commented Jan 30, 2025

Deploying docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 3964c0c
Status: ✅  Deploy successful!
Preview URL: https://5187c756.docodile.pages.dev
Branch Preview URL: https://registry-team-access-bulk.docodile.pages.dev

View logs

@ngrayluna ngrayluna marked this pull request as ready for review February 6, 2025 17:09
@ngrayluna ngrayluna requested a review from a team as a code owner February 6, 2025 17:09
@ngrayluna
Copy link
Contributor Author

PR ready for tech review.

@ngrayluna ngrayluna requested a review from ibindlish February 6, 2025 23:54
content/guides/models/registry/configure_registry.md Outdated Show resolved Hide resolved
content/guides/models/registry/configure_registry.md Outdated Show resolved Hide resolved
content/guides/models/registry/configure_registry.md Outdated Show resolved Hide resolved
content/guides/models/registry/configure_registry.md Outdated Show resolved Hide resolved

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" %}}
Copy link
Contributor

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.

Copy link
Contributor Author

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? :)?

Copy link
Contributor

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!

content/guides/models/registry/configure_registry.md Outdated Show resolved Hide resolved
content/guides/models/registry/configure_registry.md Outdated Show resolved Hide resolved
content/guides/models/registry/configure_registry.md Outdated Show resolved Hide resolved
content/guides/models/registry/configure_registry.md Outdated Show resolved Hide resolved
content/guides/models/registry/create_registry.md Outdated Show resolved Hide resolved
content/guides/models/registry/create_registry.md Outdated Show resolved Hide resolved
content/guides/models/registry/create_registry.md Outdated Show resolved Hide resolved
content/guides/models/registry/create_registry.md Outdated Show resolved Hide resolved
content/guides/models/registry/create_registry.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ibindlish ibindlish left a 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!

@ngrayluna ngrayluna requested a review from noaleetz February 7, 2025 22:51
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 44.5%, saving 72.03 KB.

Filename Before After Improvement Visual comparison
assets/images/registry/role_conflict.png 161.88 KB 89.85 KB -44.5% View diff

439 images did not require optimisation.

Copy link
Contributor

@mdlinville mdlinville left a 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.
Copy link
Contributor

Choose a reason for hiding this comment

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

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

Choose a reason for hiding this comment

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

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

@ngrayluna ngrayluna requested a review from mdlinville February 11, 2025 21:22
Copy link
Contributor

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

Choose a reason for hiding this comment

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

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

Choose a reason for hiding this comment

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

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

Choose a reason for hiding this comment

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

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

Comment on lines +19 to +20
4. Navigate to the **Registry access** section.
5. Click on the **Add access** button.
Copy link
Contributor

Choose a reason for hiding this comment

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

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

@ngrayluna ngrayluna merged commit 1867b27 into main Feb 11, 2025
7 checks passed
@ngrayluna ngrayluna deleted the registry_team_access_bulk branch February 11, 2025 22:03
ngrayluna added a commit that referenced this pull request Feb 11, 2025
@ngrayluna ngrayluna restored the registry_team_access_bulk branch February 11, 2025 22:13
ngrayluna added a commit that referenced this pull request Feb 11, 2025
ngrayluna added a commit that referenced this pull request Feb 11, 2025
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants