Update documentation. Add organization section (#4080)
* add organization section * fix linter errors * fix mistake * update roles description and other sections * fix linter error * update task-details.md * fix mistake * update review section * fix linter error * apply suggestions * fix linter errormain
Timur Osmanov
4 years ago
committed by
GitHub
@ -0,0 +1,61 @@
|
||||
---
|
||||
title: 'Organization'
|
||||
linkTitle: 'Organization'
|
||||
weight: 2
|
||||
description: 'Using organization in CVAT.'
|
||||
---
|
||||
|
||||
## Personal workspace
|
||||
|
||||
Your `Personal workspace` will display the tasks and projects you've created.
|
||||
|
||||
## Create a new organization
|
||||
|
||||
To create an organization, open the user menu, go to `Organization` and click `Create`.
|
||||
|
||||
|
||||
|
||||
Fill in the required information to create your organization.
|
||||
You need to enter a `Short name` of the organization, which will be displayed in the menu.
|
||||
You can specify other fields: `Full Name`, `Description` and the organization contacts.
|
||||
Of them will be visible on the organization settings page.
|
||||
|
||||
|
||||
|
||||
## Organization page
|
||||
|
||||
To go to the organization page, open the user menu, go to `Organization` and click `Settings`.
|
||||
|
||||
|
||||
|
||||
### Invite members into organization
|
||||
|
||||
To add members, click `Invite members`. In the window that appears,
|
||||
enter the email of the user you want to add and select the role (the role defines a set of rules):
|
||||
|
||||
- `Worker` - workers have only access to tasks, projects, and jobs, assigned to them.
|
||||
- `Supervisor` - this role allows you to create and assign jobs, tasks and projects to members of the organization.
|
||||
- `Maintainer` - a member with this role has all the capabilities of the role supervisor,
|
||||
sees all the tasks and the projects created by other members of the organization,
|
||||
has full access to the `Cloud Storages` feature, and can modify members and their roles.
|
||||
- `Owner` - a role assigned to the creator of the organization with maximum capabilities.
|
||||
|
||||
In addition to roles, there are groups of users that are configured on the `Admin page`.
|
||||
Read more about the roles in [IAM system roles section](/docs/administration/advanced/iam_system_roles).
|
||||
|
||||
|
||||
|
||||
After you add members, they will appear on your organization settings page,
|
||||
with each member listed and information about invitation details.
|
||||
You can change a member's role or remove a member at any time.
|
||||
|
||||
|
||||
|
||||
The member can leave the organization on his own by clicking `Leave organization` on the organization settings page.
|
||||
|
||||
### Remove organization
|
||||
|
||||
You can remove an organization that you created.
|
||||
Deleting an organization will delete all related resources (annotations, jobs, tasks, projects, cloud storages, ..).
|
||||
In order to remove an organization, click `Remove organization`,
|
||||
you will be asked to confirm the deletion by entering the short name of the organization.
|
||||
|
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 28 KiB |
|
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 14 KiB |
|
After Width: | Height: | Size: 16 KiB |
|
After Width: | Height: | Size: 43 KiB |
|
After Width: | Height: | Size: 19 KiB |
|
After Width: | Height: | Size: 12 KiB |
|
After Width: | Height: | Size: 50 KiB |