Skip to content

Commit

Permalink
Updated task-details documentation (#8468)
Browse files Browse the repository at this point in the history
<!-- Raise an issue to propose your change
(https://github.com/cvat-ai/cvat/issues).
It helps to avoid duplication of efforts from multiple independent
contributors.
Discuss your ideas with maintainers to be sure that changes will be
approved and merged.
Read the [Contribution guide](https://docs.cvat.ai/docs/contributing/).
-->

<!-- Provide a general summary of your changes in the Title above -->

### Motivation and context
<!-- Why is this change required? What problem does it solve? If it
fixes an open
issue, please link to the issue here. Describe your changes in detail,
add
screenshots. -->
The task details documentaion page is very outdated. It displays old UI
and some icorrect info

### How has this been tested?
<!-- Please describe in detail how you tested your changes.
Include details of your testing environment, and the tests you ran to
see how your change affects other areas of the code, etc. -->

### Checklist
<!-- Go over all the following points, and put an `x` in all the boxes
that apply.
If an item isn't applicable for some reason, then ~~explicitly
strikethrough~~ the whole
line. If you don't do that, GitHub will show incorrect progress for the
pull request.
If you're unsure about any of these, don't hesitate to ask. We're here
to help! -->
- [ ] I submit my changes into the `develop` branch
- [ ] I have created a changelog fragment <!-- see top comment in
CHANGELOG.md -->
- [ ] I have updated the documentation accordingly
- [ ] I have added tests to cover my changes
- [ ] I have linked related issues (see [GitHub docs](

https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword))
- [ ] I have increased versions of npm packages if it is necessary

([cvat-canvas](https://github.com/cvat-ai/cvat/tree/develop/cvat-canvas#versioning),

[cvat-core](https://github.com/cvat-ai/cvat/tree/develop/cvat-core#versioning),

[cvat-data](https://github.com/cvat-ai/cvat/tree/develop/cvat-data#versioning)
and

[cvat-ui](https://github.com/cvat-ai/cvat/tree/develop/cvat-ui#versioning))

### License

- [ ] I submit _my code changes_ under the same [MIT License](
https://github.com/cvat-ai/cvat/blob/develop/LICENSE) that covers the
project.
  Feel free to contact the maintainers if that's a concern.


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Documentation**
	- Updated content in the `task-details.md` for improved clarity.
	- Changed image references for better accuracy.
- Clarified terminology regarding job attributes and expanded the
description of the "Assignee."
- Removed outdated references and functionality related to the
"Reviewer" and clipboard copying.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
  • Loading branch information
klakhov authored Sep 30, 2024
1 parent 45d2d01 commit 0b7fc51
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 10 deletions.
16 changes: 6 additions & 10 deletions site/content/en/docs/manual/basics/task-details.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: 'Overview of the Task details page.'
Task details is a task page which contains a preview, a progress bar
and the details of the task (specified when the task was created) and the jobs section.

![](/images/image131_detrac.jpg)
![](/images/task-details-1.png)

- The next actions are available on this page:
1. Change the task’s title.
Expand All @@ -25,26 +25,22 @@ and the details of the task (specified when the task was created) and the jobs s

- **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.
- Frame range — the frame interval.
- A stage of the job. The stage is specified by a drop-down list.
There are three stages: `annotation`, `validation` or `acceptance`. This value affects the task progress bar.
- A state of the job. The state can be changed by an assigned user in the menu inside the job.
There are several possible states: `new`, `in progress`, `rejected`, `completed`.
- Started on — start date of this job.
- Duration — is the amount of time the job is being worked.
- Assignee is the user who is working on the job.
- Assignee is the user who is working on the job (annotator,
{{< ilink "/docs/manual/advanced/analytics-and-monitoring/manual-qa" "reviewer or corrector" >}}).
You can start typing an assignee’s name and/or choose the right person out of the dropdown list.
- Reviewer – a user assigned to carry out the review,
read more in the {{< ilink "/docs/manual/advanced/analytics-and-monitoring/manual-qa" "review" >}} section.
- `Copy`. By clicking `Copy` you will copy the job list to the clipboard.
The job list contains direct links to jobs.

You can filter or sort jobs by status, as well as by assigner or reviewer.
You can filter or sort jobs by status, assignee and updated date using filters panel.

Follow a link inside `Jobs` section to start annotation process.
In some cases, you can have several links. It depends on size of your
task and `Overlap Size` and `Segment Size` parameters. To improve
UX, only the first chunk of several frames will be loaded and you will be able
to annotate first images. Other frames will be loaded in background.

![](/images/image007_detrac.jpg)
![](/images/task-details-2.png)
Binary file removed site/content/en/images/image007_detrac.jpg
Binary file not shown.
Binary file removed site/content/en/images/image131_detrac.jpg
Binary file not shown.
Binary file added site/content/en/images/task-details-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/content/en/images/task-details-2.png
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 0b7fc51

Please sign in to comment.