Update documentation. Update sections about pages #4480
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
bsekachev
reviewed
Mar 17, 2022
Comment on lines
49
to
70
| | Properties | Supported values | Description | | ||
| | -------------- | -------------------------------------------- | ------------------------------------------- | | ||
| | `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)) | | ||
| | `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 | | ||
| | `Status` | `annotation`, `validation` or `completed` | | | ||
| | `Data` | `video`, `images` | Depends on the data format <br>(read more in [creating an annotation task](/docs/manual/basics/creating_an_annotation_task)) | | ||
| | `Subset` | `test`, `train`, `validation` or custom subset | | | ||
| | `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 | | ||
| | `Task ID` | number or range of task ID | | | ||
| | `Project ID` | number or range of project ID | | | ||
| | `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/)) | | ||
| | `Provider type` | `AWS S3`, `Azure`, `Google cloud` | | | ||
| | `Credentials type` | `Key & secret key`, `Account name and token`,<br> `Anonymous access`, `Key file` | | | ||
| | `Description` | | Description of the cloud storage | | ||
| | `Resource name` | | `Bucket name` or `container name` | | ||
| | `Display name` | | Set when creating cloud storage | |
There was a problem hiding this comment.
Do not you think it would be better to divide them to different tables? (tasks, projects, jobs, cloud storages). Part of rows will be repeated, but one table looks a bit difficult
There was a problem hiding this comment.
I wanted to avoid repetition, but it's probably better to have a separate tables. I made some tables with properties and moved them to the appropriate sections
Comment on lines
133
to
154
| - `ID` - ID project, task or job | ||
| - `Assignee` - the user to whom the project, task or job is assigned | ||
| - `Owner` - the user who owns the project, task, or job | ||
| - `Status` - sort by status (`annotation`, `validation` or `completed`) | ||
| - `Updated date` - time and date of last saved project, task or job | ||
| - `Stage` - stage set on the task page | ||
| - `State` - state set by a user assigned to the job | ||
| - `Subset` - sort by subset (`test`, `train`, `validation` or custom subset | ||
| ) | ||
| - `Mode` - sort by mode (`interpolation - video` or `annotation - images`) | ||
| - `Dimension` - sort by dimension `2D` and `3D`, | ||
| read more in [creating an annotation task](/docs/manual/basics/creating_an_annotation_task) | ||
| - `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. | ||
| - `Name` - name of task or project | ||
| - `Task name` - the name of the task to which the job belongs | ||
| - `Project name` - the name of the project containing the task or the task to which the job belongs. | ||
| - `Provider type` - sort by provider (`AWS S3`, `Azure`, `Google cloud`) | ||
| - `Credentials` - sort by credentials (`Key & secret key`, `Account name and token`, `Anonymous access`, `Key file`) | ||
| - `Description` - sort by description | ||
| - `Resource` - sort by resource (`bucket name` or `container name`) | ||
| - `Display name` - sort by display name |
There was a problem hiding this comment.
The same comment about splitting into different groups.
The most of descriptions here (like Description - sort by description, Name - name of task or projects) seem to be totally useless.
Maybe define such formats:
Tasks: ID, assignee, owner, status, ...
Projects: ID, assignee, owner, status, ....
Cloud storages: Description, display name, ....
| ## Sort and filter projects, tasks, jobs and cloud storage | ||
|
|
||
| On the [projects](/docs/manual/advanced/projects/#projects-page), [tasks](/docs/manual/basics/tasks-page/), | ||
| [jobs](/docs/manual/basics/jobs-page/), and [cloud storage](/docs/manual/basics/cloud-storages/) pages, |
There was a problem hiding this comment.
Also on a project page, we have a list of tasks with ability to sort/filter
| sorting will occur according to the order of parameters, starting from the top. | ||
|
|
||
| Pressing the `Sort button` switches between `Ascending sort`/`Descending sort`. | ||
|
|
There was a problem hiding this comment.
Sorting is also displayed in the browser URL
bsekachev
approved these changes
Mar 18, 2022
|
Looks like remark lint error is not related with this pull request, but could you please add a new line to the end of file |
…te-sections-about-pages
mikhail-treskin
pushed a commit
to retailnext/cvat
that referenced
this pull request
Jun 22, 2022
* 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
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 #4409
Motivation and context
preview:
In this PR:
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.