Update documentation. Add organization section #4080
Merged
Conversation
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
added 3 commits
December 24, 2021 11:27
bsekachev
reviewed
Dec 29, 2021
| ### 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 (set of rules): |
There was a problem hiding this comment.
Suggested change
| enter the email of the user you want to add and select the role (set of rules): | |
| enter the email of the user you want to add and select the role (the role defines a set of rules): |
| 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 (set of rules): | ||
|
|
||
| - `Worker` - worker sees only the tasks and projects assigned to it. Worker can work in the task assigned to it, |
There was a problem hiding this comment.
Suggested change
| - `Worker` - worker sees only the tasks and projects assigned to it. Worker can work in the task assigned to it, | |
| - `Worker` - workers have only access to tasks, projects, and jobs, assigned to them. |
| enter the email of the user you want to add and select the role (set of rules): | ||
|
|
||
| - `Worker` - worker sees only the tasks and projects assigned to it. Worker can work in the task assigned to it, | ||
| as well as create and comment issues. |
There was a problem hiding this comment.
Suggested change
| as well as create and comment issues. |
Comment on lines
38
to
39
| - `Supervisor` - supervisor role in addition to all the features of the worker, | ||
| allows you to create and assign jobs, tasks and projects to members of the organization. |
There was a problem hiding this comment.
Suggested change
| - `Supervisor` - supervisor role in addition to all the features of the worker, | |
| allows you to create and assign jobs, tasks and projects to members of the organization. | |
| - `Supervisor` - this role allows you to create and assign jobs, tasks and projects to members of the organization. |
Comment on lines
40
to
42
| - `Maintainer` - maintainer role has all the capabilities of the role supervisor, | ||
| sees all tasks and projects created by other members of the organization, and can create, | ||
| update and remove `Cloud Storage`, add and remove organization members and modify member roles. |
There was a problem hiding this comment.
Suggested change
| - `Maintainer` - maintainer role has all the capabilities of the role supervisor, | |
| sees all tasks and projects created by other members of the organization, and can create, | |
| update and remove `Cloud Storage`, add and remove organization members and modify member roles. | |
| - `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. |
| There are three types of status: annotation, validation or completed. | ||
| The status of the job is changes the progress bar of the task. | ||
| - A stage of the job. The stage is specified by a drop-down list. | ||
| There are three stage: `annotation`, `validation` or `acceptance`. |
There was a problem hiding this comment.
Suggested change
| There are three stage: `annotation`, `validation` or `acceptance`. | |
| There are three stages: `annotation`, `validation` or `acceptance`. |
| The status of the job is changes the progress bar of the task. | ||
| - A stage of the job. The stage is specified by a drop-down list. | ||
| There are three stage: `annotation`, `validation` or `acceptance`. | ||
| The stage of the job is changes the progress bar of the task. |
There was a problem hiding this comment.
Suggested change
| The stage of the job is changes the progress bar of the task. | |
| This value affects the task progress bar. |
| - A stage of the job. The stage is specified by a drop-down list. | ||
| There are three stage: `annotation`, `validation` or `acceptance`. | ||
| The stage of the job is changes the progress bar of the task. | ||
| - A state of the job. The status is specified by the user in the menu inside the job. |
There was a problem hiding this comment.
Suggested change
| - A state of the job. The status is specified by the user in the menu inside the job. | |
| - A state of the job. The state can be changed by an assigned user in the menu inside the job. |
| There are three stage: `annotation`, `validation` or `acceptance`. | ||
| The stage of the job is changes the progress bar of the task. | ||
| - A state of the job. The status is specified by the user in the menu inside the job. | ||
| There are four types of state: `new`, `in progress`, `rejected`, `completed`. |
There was a problem hiding this comment.
Suggested change
| There are four types of state: `new`, `in progress`, `rejected`, `completed`. | |
| There are several possible states: `new`, `in progress`, `rejected`, `completed`. |
|
|
||
| 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 enter the `Full Name`, the `Description` and the contact details |
There was a problem hiding this comment.
Suggested change
| You can enter the `Full Name`, the `Description` and the contact details | |
| You can specify other fields: `Full Name`, `Description` and the organization contacts. |
added 2 commits
December 30, 2021 08:27
bsekachev
approved these changes
Dec 30, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related #3788
Motivation and context
This PR added documentation about using organizations in CVAT with using UI.
How has this been tested?
Checklist
developbranchcvat-core, cvat-data and cvat-ui)
License
Feel free to contact the maintainers if that's a concern.