Improve documentation, correction of the "Creating an annotation task" page structure (#3586)

* updating creating task page

* remark fixes

* corrected info about synchronization status
main
Artem Filippov 5 years ago committed by GitHub
parent bc2dc7774c
commit 9f31fb3882
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -5,10 +5,10 @@ weight: 2
description: 'Instructions on how to create and configure an annotation task.' description: 'Instructions on how to create and configure an annotation task.'
--- ---
1. Create an annotation task pressing `Create new task` button on the tasks page or on the project page. Create an annotation task pressing `Create new task` button on the tasks page or on the project page.
![](/images/image004.jpg) ![](/images/image004.jpg)
1. Specify parameters of the task: Specify parameters of the task:
## Basic configuration ## Basic configuration
@ -210,7 +210,7 @@ description: 'Instructions on how to create and configure an annotation task.'
- `github.com/project/repos[.git]` - `github.com/project/repos[.git]`
- `git@github.com:project/repos[.git]` - `git@github.com:project/repos[.git]`
The task will be highlighted in red after creation if annotation isn't synchronized with the repository. After the task is created, the synchronization status is displayed on the task page.
### Use LFS ### Use LFS
@ -222,29 +222,4 @@ description: 'Instructions on how to create and configure an annotation task.'
Specify full issue tracker's URL if it's necessary. Specify full issue tracker's URL if it's necessary.
Push `Submit` button and it will be added into the list of annotation tasks. Push `Submit` button and it will be added into the list of annotation tasks.
Then, the created task will be displayed on a tasks page: Then, the created task will be displayed on a [tasks page](/docs/manual/basics/tasks-page/).
![](/images/image006_detrac.jpg)
1. The tasks page contains elements and each of them relates to a separate task. They are sorted in creation order.
Each element contains: task name, preview, progress bar, button `Open`, and menu `Actions`.
Each button is responsible for a in menu `Actions` specific function:
- `Export task dataset` — download annotations or annotations and images in a specific format.
More information is available in the [Downloading annotations](/docs/manual/advanced/downloading-annotations/)
section.
- `Upload annotation` is available in the same formats as in `Export task dataset`. The
[CVAT](/docs/manual/advanced/xml_format/) format accepts both video and image sub-formats.
- `Automatic Annotation` — automatic annotation with OpenVINO toolkit.
Presence depends on how you build CVAT instance.
- `Export task` — Export a task into a zip archive.
Read more in the [export/import a task](/docs/manual/advanced/export-import/) section.
- `Move to project` — Moving the task to the project (can be used to move a task from one project to another).
Note that attributes reset during the moving process. In case of label mismatch,
you can create or delete necessary labels in the project/task.
Some task labels can be matched with the target project labels.
- `Delete` — delete task.
---
Push `Open` button to go to [task details](/docs/manual/basics/task-details/).

@ -0,0 +1,31 @@
---
title: 'Tasks page'
linkTitle: 'Tasks page'
weight: 2.5
description: 'Overview of the Tasks page.'
---
![](/images/image006_detrac.jpg)
The tasks page contains elements and each of them relates to a separate task. They are sorted in creation order.
Each element contains: task name, preview, progress bar, button `Open`, and menu `Actions`.
Each button is responsible for a in menu `Actions` specific function:
- `Export task dataset` — download annotations or annotations and images in a specific format.
More information is available in the [Downloading annotations](/docs/manual/advanced/downloading-annotations/)
section.
- `Upload annotation` is available in the same formats as in `Export task dataset`. The
[CVAT](/docs/manual/advanced/xml_format/) format accepts both video and image sub-formats.
- `Automatic Annotation` — automatic annotation with OpenVINO toolkit.
Presence depends on how you build CVAT instance.
- `Export task` — Export a task into a zip archive.
Read more in the [export/import a task](/docs/manual/advanced/export-import/) section.
- `Move to project` — Moving the task to the project (can be used to move a task from one project to another).
Note that attributes reset during the moving process. In case of label mismatch,
you can create or delete necessary labels in the project/task.
Some task labels can be matched with the target project labels.
- `Delete` — delete task.
---
Push `Open` button to go to [task details](/docs/manual/basics/task-details/).
Loading…
Cancel
Save