Update documentation. Add information about git flexibility after task creation (#4401)

* update task-synchronization.md, creating_an_annotation_task.md and task-details.md

* update task-details.md

* fix mistake

* apply suggestions

* fix linter error
main
Timur Osmanov 4 years ago committed by GitHub
parent cc98ff0584
commit 07ae9a3e4f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -4,19 +4,22 @@ linkTitle: 'Task synchronization'
weight: 19
---
> Notice: this feature works only if a git repository was specified when the task was created.
1. At the end of the annotation process, a task is synchronized by clicking
`Synchronize` on the task page. Notice: this feature
works only if a git repository was specified when the task was created.
`Synchronize` on the task page. If the synchronization is successful,
the button will change to `Sychronized` in blue:
![](/images/image106.jpg)
![](/images/image110.jpg)
1. After synchronization the button `Sync` is highlighted in green. The
annotation is now in the repository in a temporary branch.
1. The annotation is now in the repository in a temporary branch.
The next step is to go to the repository and manually create a pull request to the main branch.
![](/images/image109.jpg)
1. After merging the PR, when the annotation is saved in the main branch,
the button changes to `Merged` and is highlighted in green.
1. The next step is to go to the repository and manually create a pull request to the main branch.
![](/images/image109.jpg)
1. After confirming the PR, when the annotation is saved in the main branch, the color of the task changes to blue.
If annotation in the task does not correspond annotations in the repository, the sync button will turn red:
![](/images/image110.jpg)
![](/images/image106.jpg)

@ -153,7 +153,7 @@ Use this option to specify quality of uploaded images.
The option helps to load high resolution datasets faster.
Use the value from `5` (almost completely compressed images) to `100` (not compressed images).
## Overlap Size
### Overlap Size
Use this option to make overlapped segments.
The option makes tracks continuous from one segment into another.
@ -224,6 +224,11 @@ Supported URL formats :
After the task is created, the synchronization status is displayed on the task page.
If you specify a dataset repository, when you create a task, you will see a message
about the need to grant access with the ssh key.
This is the key you need to [add to your github account](https://github.com/settings/keys).
For other git systems, you can learn about adding an ssh key in their documentation.
### Use LFS
If the annotation file is large, you can create a repository with

@ -12,16 +12,27 @@ and the details of the task (specified when the task was created) and the jobs s
- The next actions are available on this page:
1. Change the tasks title.
2. Open `Actions` menu.
3. Change issue tracker or open issue tracker if it is specified.
4. Change labels (available only if the task is not related to the project).
1. Open `Actions` menu.
1. Change issue tracker or open issue tracker if it is specified.
1. Change labels (available only if the task is not related to the project).
You can add new labels or add attributes for the existing labels in the Raw mode or the Constructor mode.
By clicking `Copy` you will copy the labels to the clipboard.
5. Assigned to — is used to assign a task to a person. Start typing an assignees name and/or
1. Assigned to — is used to assign a task to a person. Start typing an assignees name and/or
choose the right person out of the dropdown list.
In the list of users, you will only see the users of the [organization](/docs/manual/advanced/organization/)
where the task is created.
- `Jobs` — is a list of all jobs for a particular task. Here you can find the next data:
1. Dataset Repository
- Repository link
- Synchronization status with dataset repository.
When you click on the status, the current annotation will be sent. It has several states:
- Synchronized - task synchronized, that is, created a pull of requisites with an actual annotation file.
- Merged - merged pull request with up-to-date annotation file.
- Synchronize - highlighted in red, annotations are not synced.
- Use a format drop-down list of formats in which the annotation can be synchronized.
- Support for large file enabling the use of [LFS](https://git-lfs.github.com/).
- **Jobs** — is a list of all jobs for a particular task. Here you can find the next data:
- Jobs name with a hyperlink to it.
- Frames — the frame interval.
- A stage of the job. The stage is specified by a drop-down list.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 43 KiB

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 97 KiB

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 98 KiB

After

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 88 KiB

After

Width:  |  Height:  |  Size: 98 KiB

Loading…
Cancel
Save