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

Feat/cvat.735 docs #747

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 34 additions & 0 deletions design-docs/CVAT Updating with Upstream.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Assume all file paths are from project root.

# `Dockerfile`
Usually, we add vim and nano to the build for ease of debugging remotely (and inside
the CLI).
![](.CVAT Updating with Upstream_images/7037581f.png)
- Not required

# `.gitignore`
If you're using JetBrains IDE products, this will keep out their IDE folder.
![](.CVAT Updating with Upstream_images/9f162879.png)

# `cvat/requirements/base.txt`
Add onepanel-sdk and google-cloud-storage.
- SDK for our authentication and creating workflows on onepanel, from inside CVAT.
- Google Cloud Storage because we support uploading to GCS.
- Storing annotations, etc

![](.CVAT Updating with Upstream_images/438146d0.png)

# Copy everything over `cvat/apps/onepanelio`
![](.CVAT Updating with Upstream_images/7a2f91b9.png)

# Add relevant onepanel URLs to `cvat/urls.py`
![](.CVAT Updating with Upstream_images/e9122ada.png)

# Update `cvat/settings/base.py` to enable onepanel related pieces.
![](.CVAT Updating with Upstream_images/147082c5.png)
![](.CVAT Updating with Upstream_images/02441b19.png)

# As of right now, we need to enable environment variables for CVAT as well.
`cvat/settings/base.py`
![](.CVAT Updating with Upstream_images/92b76b3c.png)
![](.CVAT Updating with Upstream_images/dead64db.png)