Update documentation. Update sections about pages (cvat-ai#4480)

* update docs * fix linter errors * fix and resize image100_detrac.jpg * apply part of suggestions * apply suggestions * fix linter errors * fix links * fix linter error * fix mistake * fix mistake
suzusuzu · Mar 18, 2022 · d42e37c · d42e37c
1 parent b7e881f
commit d42e37c
Show file tree

Hide file tree

Showing 17 changed files with 297 additions and 74 deletions.
diff --git a/site/content/en/docs/manual/advanced/filter.md b/site/content/en/docs/manual/advanced/filter.md
@@ -44,7 +44,13 @@ The `Add rule` button adds a rule for objects display. A rule may use the follow
 | `ObjectID`   | number or field                                        | ID of the object in your client <br>(indicated on the objects sidebar) |
 | `Attributes` | some other fields including attributes with a <br>similar type or a specific attribute value | any fields specified by a label |
 
-[Supported properties for jobs list](/docs/manual/basics/jobs-page/#supported-properties-for-jobs-list)
+- [Supported properties for projects list](/docs/manual/advanced/projects/#supported-properties-for-projects-list)
+
+- [Supported properties for tasks list](/docs/manual/basics/tasks-page/#supported-properties-for-tasks-list)
+
+- [Supported properties for jobs list](/docs/manual/basics/jobs-page/#supported-properties-for-jobs-list)
+
+- [Supported properties for cloud storages list](/docs/manual/basics/cloud-storages/#supported-properties-for-cloud-storages-list)
 
 ### Supported operators for properties
 
@@ -95,3 +101,62 @@ Click `Submit` to apply the filter.
 The `Cancel` button undoes the filter. The `Clear filter` button removes the filter.
 
 Once applied filter automatically appears in `Recent used` list. Maximum length of the list is 10.
+
+---
+
+## Sort and filter lists
+
+On the [projects](/docs/manual/advanced/projects/#projects-page), task list on the project page,
+[tasks](/docs/manual/basics/tasks-page/), [jobs](/docs/manual/basics/jobs-page/),
+and [cloud storage](/docs/manual/basics/cloud-storages/) pages, you can use sorting and filters.
+
+> The applied filter and sorting will be displayed in the URL of your browser,
+> Thus, you can share the page with sorting and filter applied.
+
+### Sort by
+
+You can sort by the following parameters:
+- Jobs list: ID, assignee, updated date, [stage][stage], [state][state], task ID, project ID,
+task name, project name.
+- Tasks list or tasks list on project page: ID, owner, status, assignee, updated date, [subset][subset], [mode][mode],
+[dimension][dimension], project ID, name, project name.
+- Projects list: ID, assignee, owner, status, name, updated date.
+- Cloud storages list: ID, provider type, updated date, display name, [resource][resource],
+[credentials][credentials], owner, description.
+
+To apply sorting, drag the parameter to the top area above the horizontal bar.
+The parameters below the horizontal line will not be applied.
+By moving the parameters you can change the priority,
+first of all sorting will occur according to the parameters that are above.
+
+Pressing the `Sort button` switches `Ascending sort`/`Descending sort`.
+
+### Quick filters
+
+Quick Filters contain several frequently used filters:
+- `Assigned to me` - show only those projects, tasks or jobs that are assigned to you.
+- `Owned by me` -  show only those projects or tasks that are owned by you.
+- `Not completed` - show only those projects, tasks or jobs that have a status other than completed.
+- `AWS storages` - show only AWS cloud storages
+- `Azure storages` - show only Azure cloud storages
+- `Google cloud storages` - show only Google cloud storages
+
+#### Date and time selection
+
+When creating a `Last updated` rule, you can select the date and time by using the selection window.
+
+![](/images/image244_detrac.jpg)
+
+You can select the year and month using the arrows or by clicking on the year and month.
+To select a day, click on it in the calendar,
+To select the time, you can select the hours and minutes using the scrolling list.
+Or you can select the current date and time by clicking the `Now` button.
+To apply, click `Ok`.
+
+[state]: /docs/manual/basics/vocabulary/#state
+[stage]: /docs/manual/basics/vocabulary/#stage
+[subset]: /docs/manual/basics/vocabulary/#subset
+[resource]: /docs/manual/basics/vocabulary/#resource
+[credentials]: /docs/manual/basics/vocabulary/#credentials
+[mode]: /docs/manual/basics/vocabulary/#mode
+[dimension]: /docs/manual/basics/vocabulary/#dimension
diff --git a/site/content/en/docs/manual/advanced/projects.md b/site/content/en/docs/manual/advanced/projects.md
@@ -1,23 +1,56 @@
 ---
-title: 'Projects'
-linkTitle: 'Projects'
+title: 'Projects page'
+linkTitle: 'Projects page'
 weight: 1
 description: 'Creating and exporting projects in CVAT.'
 ---
 
-### Create project
+## Projects page
+
+On this page you can create a new project, create a project from a backup, and also see the created projects.
+
+In the upper left corner there is a search bar, using which you can find the project by project name, assignee etc.
+In the upper right corner there are [sorting][sorting], [quick filters][quick-filters] and filter.
+
+## Filter
+
+> Applying filter disables the [quick filter][quick-filters].
+
+The filter works similarly to the filters for annotation,
+you can create rules from [properties](#supported-properties-for-projects-list),
+[operators][operators] and values and group rules into [groups][groups].
+For more details, see the [filter section][create-filter].
+Learn more about [date and time selection][data-and-time].
+
+For clear all filters press `Clear filters`.
+
+### Supported properties for projects list
+
+| Properties     | Supported values                             | Description                                 |
+| -------------- | -------------------------------------------- | ------------------------------------------- |
+| `Assignee`     | username                                     | Assignee is the user who is working on the project, task or job. <br>(is specified on task page) |
+| `Owner`        | username                                     | The user who owns the project, task, or job |
+| `Last updated` | last modified date and time (or value range) | The date can be entered in the `dd.MM.yyyy HH:mm` format <br>or by selecting the date in the window that appears <br>when you click on the input field |
+| `ID`           | number or range of job ID                    |                                             |
+| `Name`         | name                                         | On the tasks page - name of the task,<br> on the project page - name of the project |
+
+## Create a project
 
 At CVAT, you can create a project containing tasks of the same type.
 All tasks related to the project will inherit a list of labels.
 
 To create a project, go to the projects section by clicking on the `Projects` item in the top menu.
 On the projects page, you can see a list of projects, use a search,
-or create a new project by clicking `Create New Project`.
+or create a new project by clicking on the `+` button and select `Create New Project`.
 
 ![](/images/image190.jpg)
 
+> Note that the project will be created in the organization that you selected at the time of creation.
+> Read more about [organizations](/docs/manual/advanced/organization/).
+
 You can change: the name of the project, the list of labels
 (which will be used for tasks created as parts of this project) and a link to the issue.
+Learn more about [creating a label list](/docs/manual/basics/creating_an_annotation_task/#labels).
 
 ![](/images/image191.jpg)
 
@@ -40,8 +73,16 @@ Here you can do the following:
    You can also change the color for different labels. By clicking `Copy` you can copy the labels to the clipboard.
 1. Assigned to — is used to assign a project to a person.
    Start typing an assignee's name and/or choose the right person out of the dropdown list.
-1. `Tasks` — is a list of all tasks for a particular project, with the ability to search for tasks in the project.
+1. `Tasks` — is a list of all tasks for a particular project, with the ability to search,
+   sort and filter for tasks in the project.
    [Read more about search](/docs/manual/advanced/search/).
-
+   [Read more about sorting and filter](/docs/manual/advanced/filter/#sort-and-filter-projects-tasks-and-jobs)
 It is possible to choose a subset for tasks in the project. You can use the available options
 (`Train`, `Test`, `Validation`) or set your own.
+
+[create-filter]: /docs/manual/advanced/filter/#create-a-filter
+[operators]: /docs/manual/advanced/filter/#supported-operators-for-properties
+[groups]: /docs/manual/advanced/filter/#groups
+[data-and-time]: /docs/manual/advanced/filter#date-and-time-selection
+[sorting]: /docs/manual/advanced/filter/#sort-by
+[quick-filters]: /docs/manual/advanced/filter/#quick-filters
diff --git a/site/content/en/docs/manual/basics/attach-cloud-storage.md b/site/content/en/docs/manual/basics/attach-cloud-storage.md
@@ -5,7 +5,8 @@ weight: 21
 description: 'Instructions on how to attach cloud storage using UI'
 ---
 
-In CVAT you can use AWS-S3 and Azure Blob Container cloud storages to store image datasets for your tasks.
+In CVAT you can use [AWS-S3](using-aws-s3), [Azure Blob Container](#using-azure-blob-container)
+and [Google cloud](#using-google-cloud-storage) storages to store image datasets for your tasks.
 
 ## Using AWS-S3
 
@@ -231,8 +232,8 @@ Now you can attach new cloud storage into CVAT.
 ## Attach new cloud storage
 
 After you upload the dataset and manifest file to AWS-S3, Azure Blob Container or Google Cloud Storage
-you will be able to attach a cloud storage. To do this, press the `Attach new cloud storage`
-button on the `Cloud storages` page and fill out the following form:
+you will be able to attach a cloud storage. To do this, press the `+` button on the `Cloud storages` page
+and fill out the following form:
 
 ![](/images/image228.jpg)
 

diff --git a/site/content/en/docs/manual/basics/cloud-storages.md b/site/content/en/docs/manual/basics/cloud-storages.md
@@ -20,4 +20,40 @@ Each button in the action menu is responsible for a specific function:
 This preview will appear when it is impossible to get a real preview (e.g. storage is empty or
 invalid credentials were used).
 
-Click the `Attach a new storage` button to [attach a new storage](/docs/manual/basics/attach-cloud-storage/).
+In the upper left corner there is a search bar,
+using which you can find the cloud storage by display name, provider, etc.
+In the upper right corner there are [sorting][sorting], [quick filters][quick-filters] and filter.
+
+## Filter
+
+> Applying filter disables the [quick filter][quick-filters].
+
+The filter works similarly to the filters for annotation,
+you can create rules from [properties](#supported-properties-for-jobs-list),
+[operators][operators] and values and group rules into [groups][groups].
+For more details, see the [filter section][create-filter].
+Learn more about [date and time selection][data-and-time].
+
+For clear all filters press `Clear filters`.
+
+### Supported properties for cloud storages list
+
+| Properties     | Supported values                             | Description                                 |
+| -------------- | -------------------------------------------- | ------------------------------------------- |
+| `ID`           | number or range of task ID                   |                                             |
+| `Provider type` | `AWS S3`, `Azure`, `Google cloud`           |                                             |
+| `Credentials type` | `Key & secret key`, `Account name and token`,<br> `Anonymous access`, `Key file` |     |
+| `Resource name` |                                             | `Bucket name` or `container name`           |
+| `Display name` |                                              | Set when creating cloud storage             |
+| `Description`  |                                              | Description of the cloud storage            |
+| `Owner`        | username                                     | The user who owns the project, task, or job |
+| `Last updated` | last modified date and time (or value range) | The date can be entered in the `dd.MM.yyyy HH:mm` format <br>or by selecting the date in the window that appears <br>when you click on the input field |
+
+Click the `+` button to [attach a new cloud storage](/docs/manual/basics/attach-cloud-storage/).
+
+[create-filter]: /docs/manual/advanced/filter/#create-a-filter
+[operators]: /docs/manual/advanced/filter/#supported-operators-for-properties
+[groups]: /docs/manual/advanced/filter/#groups
+[data-and-time]: /docs/manual/advanced/filter#date-and-time-selection
+[sorting]: /docs/manual/advanced/filter/#sort-by
+[quick-filters]: /docs/manual/advanced/filter/#quick-filters
diff --git a/site/content/en/docs/manual/basics/creating_an_annotation_task.md b/site/content/en/docs/manual/basics/creating_an_annotation_task.md
@@ -5,9 +5,12 @@ weight: 2
 description: 'Instructions on how to create and configure an annotation task.'
 ---
 
-Create an annotation task pressing `Create new task` button on the tasks page or on the project page.
+Create an annotation task pressing `+` button and select `Create new task` on the tasks page or on the project page.
 ![](/images/image004.jpg)
 
+> Notice that the task will be created in the organization that you selected at the time of creation.
+> Read more about [organizations](/docs/manual/advanced/organization/).
+
 Specify parameters of the task:
 
 ## Basic configuration

diff --git a/site/content/en/docs/manual/basics/jobs-page.md b/site/content/en/docs/manual/basics/jobs-page.md
@@ -12,53 +12,28 @@ as well as track progress, sort and apply filters to the job list.
 
 On the job page there is a list of jobs presented in the form of tiles, where each tile is one job.
 Each element contains:
-    - job ID
-    - dimension 2D or 3D
-    - preview
-    - stage and state [see vocabulary section](/docs/manual/basics/vocabulary)
-    - when hovering over an element, you can see:
-        - size
-        - assignee
-    - menu to navigate to a task, project, or bug tracker.
+- job ID
+- dimension `2D` or `3D`
+- preview
+- [stage][stage] and [state][state]
+- when hovering over an element, you can see:
+  - size
+  - assignee
+- menu to navigate to a task, project, or bug tracker.
 
-In the upper right corner there is a search bar, using which you can find the job by designated user, stage, state, etc.
-In the upper left corner there are sorting and filtering tools.
+> To open the job in a new tab, click on the job by holding `Ctrl`.
 
-## Sort by
-
-You can sort the jobs by the following parameters:
-    - `ID` - ID Jobs
-    - `Assignee` - the user to whom the job is assigned
-    - `Updated date` - time and date of last saved job
-    - `Stage` - stage set on the task page
-    - `State` - state set by a user assigned to the job
-    - `Task ID` - the ID of the task to which the job belongs
-    - `Project ID` - the ID of the project containing the task to which the job belongs.
-    - `Task name` - the name of the task to which the job belongs
-    - `Project name` - the name of the project containing the task to which the job belongs.
-
-To apply sorting, drag the parameter to the top area above the horizontal bar.
-The parameters below the horizontal line will not be applied.
-By moving the parameters you can change the priority,
-first of all sorting will occur according to the parameters that are above.
-
-Pressing the `Sort button` switches `Ascending sort`/`Descending sort`.
-
-## Quick filters
-
-Quick Filters contain several frequently used filters:
-- `Assigned to me` - show only those jobs that are assigned to you.
-- `Not completed` - show only those jobs that have a status other than completed.
+In the upper left corner there is a search bar, using which you can find the job by assignee, stage, state, etc.
+In the upper right corner there are [sorting][sorting], [quick filters][quick-filters] and filter.
 
 ## Filter
 
-> Applying filter disables the quick filter.
+> Applying filter disables the [quick filter][quick-filters].
 
 The filter works similarly to the filters for annotation,
-you can create rules from [properties](#supported-properties-for-jobs-list),
-[operators](/docs/manual/advanced/filter/#supported-operators-for-properties)
-and values and group rules into [groups](/docs/manual/advanced/filter/#groups).
-For more details, see the [filter section](/docs/manual/advanced/filter#create-a-filter).
+you can create rules from [properties](#supported-properties-for-jobs-list), [operators][operators]
+and values and group rules into [groups][groups]. For more details, see the [filter section][create-filter].
+Learn more about [date and time selection][data-and-time].
 
 For clear all filters press `Clear filters`.
 
@@ -68,7 +43,7 @@ For clear all filters press `Clear filters`.
 | -------------- | -------------------------------------------- | ------------------------------------------- |
 | `State`        | all the state names                          | The state of the job <br>(can be changed in the menu inside the job) |
 | `Stage`        | all the stage names                          | The stage of the job <br>(is specified by a drop-down list on the task page) |
-| `Dimension`    | `2D` or `3D`                                 | Depends on the data format <br>(read more in [creating an annotation task](/docs/manual/basics/creating_an_annotation_task)) |
+| `Dimension`    | `2D` or `3D`                                 | Depends on the data format <br>(read more in [creating an annotation task][create-task]) |
 | `Assignee`     | username                                     | Assignee is the user who is working on the job. <br>(is specified on task page) |
 | `Last updated` | last modified date and time (or value range) | The date can be entered in the `dd.MM.yyyy HH:mm` format <br>or by selecting the date in the window that appears <br>when you click on the input field |
 | `ID`           | number or range of job ID                    |                                             |
@@ -77,14 +52,12 @@ For clear all filters press `Clear filters`.
 | `Task name`    | task name                                    | Set when creating a task, <br>can be changed on the ([task page](/docs/manual/basics/task-details/)) |
 | `Project name` | project name                                 | Specified when creating a project, <br>can be changed on the ([project section](/docs/manual/advanced/projects/)) |
 
-### Date and time selection
-
-When creating a `Last updated` rule, you can select the date and time by using the selection window.
-
-![](/images/image244_detrac.jpg)
-
-You can select the year and month using the arrows or by clicking on the year and month,
-to select a day, click on it in the calendar,
-To select the time, you can select the hours and minutes using the scrolling list.
-Or you can select the current date and time by clicking the `Now` button.
-To apply, click `Ok`.
+[state]: /docs/manual/basics/vocabulary/#state
+[stage]: /docs/manual/basics/vocabulary/#stage
+[create-task]: /docs/manual/basics/creating_an_annotation_task
+[create-filter]: /docs/manual/advanced/filter/#create-a-filter
+[operators]: /docs/manual/advanced/filter/#supported-operators-for-properties
+[groups]: /docs/manual/advanced/filter/#groups
+[data-and-time]: /docs/manual/advanced/filter#date-and-time-selection
+[sorting]: /docs/manual/advanced/filter/#sort-by
+[quick-filters]: /docs/manual/advanced/filter/#quick-filters