Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 5 commits into from
Mar 4, 2022

Conversation

TOsmanov
Copy link
Contributor

@TOsmanov TOsmanov commented Mar 1, 2022

Related #3886

Motivation and context

In this PR updated Task details, Task synchronization and Creating an annotation task
preview:
https://tosmanov.github.io/cvat/docs/manual/basics/creating_an_annotation_task/#dataset-repository
https://tosmanov.github.io/cvat/docs/manual/advanced/task-synchronization/
https://tosmanov.github.io/cvat/docs/manual/basics/task-details/

How has this been tested?

Checklist

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.
  • I have updated the license header for each file (see an example below)
# Copyright (C) 2022 Intel Corporation
#
# SPDX-License-Identifier: MIT

@TOsmanov TOsmanov requested a review from nmanovic as a code owner March 1, 2022 05:40
@TOsmanov TOsmanov force-pushed the update-docs-git-flexibility branch from 5540cdc to 929b4fd Compare March 1, 2022 06:57
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`Synchronized` on the task page.
`Synchronize` on the task page.


![](/images/image109.jpg)
1. After confirming the PR, when the annotation is saved in the main branch,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. After confirming the PR, when the annotation is saved in the main branch,
1. After merging the PR, when the annotation is saved in the main branch,


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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you sure it is true? Synchronize button is red when annotation in the task does not correspond annotations in the repository. When it corresponds, it is blue.

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Synchronize - highlighted in red, there are sync issues.
- Synchronize - highlighted in red, annotations are not synced.

@bsekachev bsekachev merged commit 07ae9a3 into cvat-ai:develop Mar 4, 2022
mikhail-treskin pushed a commit to retailnext/cvat that referenced this pull request Jun 22, 2022
…k creation (cvat-ai#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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants