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

Markdown documentation for tasks/projects #6191

Merged
merged 67 commits into from
Jun 23, 2023
Merged

Markdown documentation for tasks/projects #6191

merged 67 commits into from
Jun 23, 2023

Conversation

bsekachev
Copy link
Member

@bsekachev bsekachev commented May 24, 2023

Motivation and context

image image image

Resolved #287
Resolved #3680
Resolved #5580

How has this been tested?

Checklist

  • I submit my changes into the develop branch
  • I have added a description of my changes into the CHANGELOG file
  • 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.

cvat/apps/engine/views.py Fixed Show fixed Hide fixed
cvat/apps/iam/permissions.py Fixed Show fixed Hide fixed
cvat/apps/iam/permissions.py Fixed Show fixed Hide fixed
request, view, scope=AnnotationGuidePermission.Scopes.UPDATE, obj=obj)
)
except AnnotationGuide.DoesNotExist as ex:
raise ValidationError(str(ex))

Check warning

Code scanning / CodeQL

Information exposure through an exception Medium

Stack trace information
flows to this location and may be exposed to an external user.
Copy link
Contributor

@klakhov klakhov left a comment

Choose a reason for hiding this comment

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

When I'm trying to open markdown setup guide page, an error occurs:
image
I can't create guide for the same reason. Am I doing something wrong?
Request payload seems ok. Task definitely exists.
image

CVAT is deployed in clean dev environment

cvat-core/src/guide.ts Outdated Show resolved Hide resolved
cvat-ui/src/components/md-guide/guide-page.tsx Outdated Show resolved Hide resolved
cvat-ui/src/components/md-guide/guide-page.tsx Outdated Show resolved Hide resolved
@bsekachev
Copy link
Member Author

bsekachev commented Jun 21, 2023

When I'm trying to open markdown setup guide page, an error occurs:

@klakhov
Do you use the latest version? There was such error, but I fixed it

@klakhov
Copy link
Contributor

klakhov commented Jun 21, 2023

When I'm trying to open markdown setup guide page, an error occurs:

@klakhov Do you use the latest version? There was such error, but I fixed it

Yes, updating branch helped to fix that

@klakhov
Copy link
Contributor

klakhov commented Jun 21, 2023

Should edit button be on the right? Maybe use
image
icon instead. It would look with issue tracker.
And Task description on project page seems a bit strange. Maybe its better to be named Description for tasks or Tasks description
image

@bsekachev
Copy link
Member Author

Should edit button be on the right? Maybe use

This is the latest design from Breeze

Task description on project page seems a bit strange

I will fix it

@bsekachev bsekachev changed the title Markdown documentation for tasks/projects [WIP] Markdown documentation for tasks/projects Jun 22, 2023
@bsekachev bsekachev changed the title [WIP] Markdown documentation for tasks/projects Markdown documentation for tasks/projects Jun 22, 2023
@bsekachev bsekachev merged commit 307db39 into develop Jun 23, 2023
52 of 63 checks passed
@bsekachev bsekachev deleted the bs/md branch June 23, 2023 09:21
@azhavoro azhavoro mentioned this pull request Jul 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants