-
Notifications
You must be signed in to change notification settings - Fork 265
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
✨ succinct documentation for resource groups (#1241)
* succinct documentation for resource groups * toctree + missing entry under Enterprise Hub * missing link in Enterprise Hub page * huggingchat reword
- Loading branch information
Showing
7 changed files
with
83 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Datasets | ||
|
||
<Tip warning={true}> | ||
This feature is part of the <a href="https://huggingface.co/enterprise" target="_blank">Enterprise Hub</a>. | ||
</Tip> | ||
|
||
Resource Groups allow Enterprise Hub organizations to enforce fine-grained access control to its repositories. | ||
|
||
Read the [documentation for Resource Groups under the Security section](./security-resource-groups). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# Advanced Access Control in Organizations with Resource Groups | ||
|
||
<Tip warning={true}> | ||
This feature is part of the <a href="https://huggingface.co/enterprise" target="_blank">Enterprise Hub</a>. | ||
</Tip> | ||
|
||
In your Hugging Face organization, you can use Resource Groups to control which members have access to specific repositories. | ||
|
||
## How does it work? | ||
|
||
Resource Groups allow organizations administrators to group related repositories together, and manage access to those repos. | ||
|
||
Resource Groups allow different teams to work on their respective repositories within the same organization. | ||
|
||
A repository can belong to only one Resource Group. | ||
|
||
Organizations members need to be added to the Resource Group to access its repositories. An Organization Member can belong to several Resource Groups. | ||
|
||
Members are assigned a role in each Resource Group that determines their permissions for the group's repositories. Four distinct roles exist for Resource Groups: | ||
|
||
- `read`: Grants read access to repositories within the Resource Group. | ||
- `contributor`: Provides extra write rights to the subset of the Organization's repositories created by the user (i.e., users can create repos and then modify only those repos). Similar to the 'Write' role, but limited to repos created by the user. | ||
- `write`: Offers write access to all repositories in the Resource Group. Users can create, delete, or rename any repository in the Resource Group. | ||
- `admin`: In addition to write permissions on repositories, admin members can administer the Resource Group — add, remove, and alter the roles of other members. They can also transfer repositories in and out of the Resource Group. | ||
|
||
In addition, Organization admins can manage all resource groups inside the organization. | ||
|
||
Resource Groups also affect the visibility of private repositories inside the organization. A private repository that is part of a Resource Group will only be visible to members of that Resource Group. Public repositories, on the other | ||
|
||
## Getting started | ||
|
||
Head to your Organization's settings, then navigate to the "Resource Group" tab in the left menu. | ||
|
||
<div class="flex justify-center"> | ||
<img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/org-resource-groups-page.png"/> | ||
<img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/org-resource-groups-page-dark.png"/> | ||
</div> | ||
|
||
If you are an admin of the organization, you can create and manage Resource Groups from that page. | ||
|
||
After creating a resource group and giving it a meaningful name, you can start adding repositories and users to it. | ||
|
||
<div class="flex justify-center"> | ||
<img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/org-resource-groups-manage-empty-page.png"/> | ||
<img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/org-resource-groups-manage-empty-page-dark.png"/> | ||
</div> | ||
|
||
Remember that a repository can be part of only one Resource Group. You'll be warned when trying to add a repository that already belongs to another Resource Group. | ||
|
||
<div class="flex justify-center"> | ||
<img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/org-resource-groups-manage-move-repo.png"/> | ||
<img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/org-resource-groups-manage-move-repo-dark.png"/> | ||
</div> | ||
|
||
## Programmatic management (API) | ||
|
||
Coming soon! | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters