Skip to content

Commit

Permalink
Merge pull request #4 from TOsmanov/update-docs-git-flexibility
Browse files Browse the repository at this point in the history
Update docs git flexibility
  • Loading branch information
TOsmanov authored Mar 2, 2022
2 parents 37f19d7 + 929b4fd commit a167d6d
Show file tree
Hide file tree
Showing 7 changed files with 33 additions and 15 deletions.
20 changes: 11 additions & 9 deletions site/content/en/docs/manual/advanced/task-synchronization.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,21 @@ 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.
`Synchronized` on the task page.

![](/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 confirming 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 synchronization fails, the `Synchronize` button will turn red:

![](/images/image110.jpg)
![](/images/image106.jpg)
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down
21 changes: 16 additions & 5 deletions site/content/en/docs/manual/basics/task-details.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 task’s 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 assignee’s name and/or
1. Assigned to — is used to assign a task to a person. Start typing an assignee’s 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, there are sync issues.
- 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.
Expand Down
Binary file modified site/content/en/images/image106.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified site/content/en/images/image109.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified site/content/en/images/image110.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified site/content/en/images/image131_detrac.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a167d6d

Please sign in to comment.