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

[Docs]: Update the team management page in the docs #1775

Merged
merged 2 commits into from
Jun 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file added docs/images/misc/team_management_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/misc/team_management_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/misc/workspace_tab_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/misc/workspace_tab_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 17 additions & 7 deletions docs/misc/team_management.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,29 @@
title: 'Team Management'
---

<Note> Role-based access control and audit trails are currently under development. </Note>
## Inviting users

To add new users to your workspace, start by clicking on **Settings** in the lower left corner of the screen. Then, navigate to the **Workspace** tab and on the far right, you will find the **Invite** button. Clicking this button will open a modal window where you can enter the email address(es) of the user(s) you wish to invite and select their role from a dropdown menu. Once you have entered the necessary information, click the **"Invite"** button to send the invitation. The user(s) will then receive an email invitation to join your workspace.

## Inviting users
<img height="600" className="dark:hidden" src="/images/misc/team_management_light.png" />
<img height="600" className="hidden dark:block" src="/images/misc/team_management_dark.png" />

### User Roles and Their Rights
- **Owner**: The Owner has full management capabilities within the workspace. This includes adding and removing members, as well as managing all settings and content. Essentially, the Owner has unrestricted access to all features and controls.

- **Workspace Admin**: A Workspace Admin can manage most aspects of the workspace, including settings and member management. However, they do not have the authority to delete the workspace itself.

- **Editor**: Editors are responsible for editing workspace content. They do not have the ability to manage members or assign roles, focusing solely on content management.

- **Evaluator**: Evaluators are tasked with evaluating models and providing feedback. They do not have editing privileges or member management rights, ensuring their role is concentrated on assessment and feedback.

To add new users to your workspace, click on settings in the lower left corner of the screen. Then select the "Workspace" tab. You can invite new users by entering their email addresses.
- **Deployment Manager**: Deployment Managers handle the management of model deployments within the workspace. Similar to Evaluators, they do not have content editing or member management rights, allowing them to specialize in deployment tasks.

<img height="600" className="dark:hidden" src="/images/basic_guides/12_workspace_config_light.png" />
<img height="600" className="hidden dark:block" src="/images/basic_guides/12_workspace_config_dark.png" />
- **Viewer**: Viewers can access and view all workspace content, but they are restricted from making any changes or managing members and roles. This role is typically for those who need to monitor progress without intervening in the workspace operations.

## Switching workspaces

If you're a member of multiple workspaces, you can switch between them by clicking the workspace name in the lower left corner of the screen. Remember, all applications in a workspace are shared among all its members.

<img height="600" className="dark:hidden" src="/images/basic_guides/13_workspace_tab_light.png" />
<img height="600" className="hidden dark:block" src="/images/basic_guides/13_workspace_tab_dark.png" />
<img height="600" className="dark:hidden" src="/images/misc/workspace_tab_light.png" />
<img height="600" className="hidden dark:block" src="/images/misc/workspace_tab_dark.png" />
Loading