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.

Sign up for GitHub

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

Jump to bottom

Run actions documentation added #7448

Merged
merged 10 commits into from
Feb 13, 2024
Merged

Run actions documentation added #7448

merged 10 commits into from
Feb 13, 2024

Conversation

mdacoca
Copy link
Contributor

@mdacoca mdacoca commented Feb 7, 2024

Motivation and context

How has this been tested?

Checklist

  • I submit my changes into the develop branch
  • I have created a changelog fragment
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • I have linked related issues (see GitHub docs)
  • I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

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.

@mdacoca mdacoca requested a review from bsekachev February 7, 2024 10:43
@mdacoca mdacoca added the documentation Documentation should be updated label Feb 7, 2024
@mdacoca mdacoca marked this pull request as ready for review February 7, 2024 10:43
@mdacoca @bsekachev
Update site/content/en/docs/enterprise/shapes-converter.md
b3c4620 
Co-authored-by: Boris Sekachev <boris.sekachev@yandex.ru>
@bsekachev
Copy link
Member

bsekachev commented Feb 8, 2024 •
edited
Loading

I believe we need two sections:

  1. Annotations actions: in a usual manual.
  2. Shape converters: in enterprise section.

plus link from annotations actions page to enterprise actions (shape converters)

bsekachev
bsekachev reviewed Feb 13, 2024
View reviewed changes
site/content/en/docs/manual/basics/top-panel.md Outdated Show resolved Hide resolved
site/content/en/docs/manual/basics/top-panel.md Outdated Show resolved Hide resolved
site/content/en/docs/enterprise/shapes-converter.md Outdated Show resolved Hide resolved
site/content/en/docs/enterprise/shapes-converter.md Outdated Show resolved Hide resolved
site/content/en/docs/enterprise/shapes-converter.md Outdated

| Field | Description |
| ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Select action** | Drop-down list with available actions: <br><li>**Remove filtered shapes** - removes all shapes in alignment with the set-up filter. Doesn't work with tracks.</li><li>**Shapes converter: masks to polygons** - converts all masks to polygons in alignment with the set-up filter.</li><li>**Shapes converter: masks to rectangles** - converts all masks to rectangles in alignment with the set-up filter.</li><li>**Shapes converter: polygon to masks** - converts all polygons to masks in alignment with the set-up filter.</li><li>**Shapes converter: polygon to rectangles** - converts all polygons to rectangles in alignment with the set-up filter.</li><li>**Shapes converter: rectangles to masks** - converts all rectangles to masks in alignment with the set-up filter.</li><li>**Shapes converter: rectangles to polygons** - converts all rectangles to polygons in alignment with the set-up filter.</li><br>**Note:** only **Remove filtered shapes** is available on the **Free** plan. |
Copy link
Member

Choose a reason for hiding this comment

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

Do you think we need to mention anytime with the set-up filter?

site/content/en/docs/enterprise/shapes-converter.md Outdated Show resolved Hide resolved
@bsekachev
Copy link
Member

bsekachev commented Feb 13, 2024 •
edited
Loading

Missing things:

  • user is recommended to save all the changes before running annotations action. Modal will also recommend to do that if there are unsaved changes.
  • user is recommended to disable auto save before running annotations action. Model will also recommend to do that if the feature is enabled
  • applied changes are not commited to the server until saving process manually triggered by a user (or by auto save feature if it is enabled)

mdacoca and others added 5 commits February 13, 2024 11:28
@mdacoca @bsekachev
Update site/content/en/docs/manual/basics/top-panel.md
350041b 
Co-authored-by: Boris Sekachev <boris.sekachev@yandex.ru>
@mdacoca @bsekachev
Update site/content/en/docs/manual/basics/top-panel.md
9fa7317 
Co-authored-by: Boris Sekachev <boris.sekachev@yandex.ru>
@mdacoca @bsekachev
Update site/content/en/docs/enterprise/shapes-converter.md
e1487bb 
Co-authored-by: Boris Sekachev <boris.sekachev@yandex.ru>
@mdacoca @bsekachev
Update site/content/en/docs/enterprise/shapes-converter.md
4158df6 
Co-authored-by: Boris Sekachev <boris.sekachev@yandex.ru>
@mdacoca
removed section
aa79f0f
@bsekachev
Copy link
Member

Could you please resolve issues with remark?

@bsekachev bsekachev merged commit e8384f8 into develop Feb 13, 2024
13 checks passed
bsekachev pushed a commit that referenced this pull request Feb 13, 2024
@mdacoca @bsekachev
Run actions documentation added (#7448)
0782dac
@bsekachev bsekachev deleted the ma/run-actions branch February 26, 2024 09:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bsekachev bsekachev bsekachev left review comments

Assignees
No one assigned
Labels
documentation Documentation should be updated
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mdacoca @bsekachev