-
Notifications
You must be signed in to change notification settings - Fork 3.1k
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
Documentation update, added info about the cloud storage UI #3724
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
d2d1806
added info about cloud storage ui
amotovx 086dec0
fixed linter errors, improved list spacing
amotovx 0d60a1c
fixed linter errors v2
amotovx 075a87e
fixed mistakes & indentation
amotovx 61dc224
Apply suggestions from code review
amotovx b15edf9
fixed errors & indentation issues
amotovx 3e978d7
fixed errors & indentation issues v2
amotovx b34e1bd
apply suggestions v2
amotovx b77f497
update preview image, add info about preview icon
amotovx File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
62 changes: 62 additions & 0 deletions
62
site/content/en/docs/manual/basics/attach-cloud-storage.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
--- | ||
title: 'Attach cloud storage' | ||
linkTitle: 'Attach cloud storage' | ||
weight: 21 | ||
description: 'Instructions on how to attach cloud storage using UI' | ||
--- | ||
|
||
In CVAT you can use AWS-S3 and Azure Blob Container cloud storages to store image datasets for your tasks. | ||
Initially you need to create a manifest file for your image dataset. Information on how to do that is available | ||
on the [Simple command line to prepare dataset manifest file](/docs/manual/advanced/dataset_manifest) page. | ||
|
||
After the manifest file has been created, you can upload it and your dataset to an AWS-S3 or | ||
Azure Blob Container cloud storage. | ||
|
||
After that you will be able to attach a cloud storage. To do this, press the `Attach new cloud storage` | ||
button on the `Cloud storages` page and fill out the following form: | ||
|
||
![](/images/image228.jpg) | ||
|
||
- `Display name` - the display name of the cloud storage. | ||
- `Description` (optional) - description of the cloud storage, appears when you click on the `?` button | ||
of an item on cloud storages page. | ||
- `Provider` - choose provider of the cloud storage: | ||
|
||
- [AWS-S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/GetStartedWithS3.html): | ||
|
||
- `Bucket` - cloud storage bucket name | ||
|
||
- [`Authorization type`](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-best-practices.html): | ||
|
||
- `Key id and secret access key pair`: | ||
- `ACCESS KEY ID` | ||
- `SECRET ACCESS KEY ID` | ||
|
||
- `Anonymous access` | ||
|
||
- `Region` - here you can choose a region from the list or add a new one. To get more information click | ||
on [`?`](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions) | ||
|
||
</br> | ||
|
||
- [Azure Blob Container](https://docs.microsoft.com/en-us/azure/storage/blobs/): | ||
|
||
- `Container name` - name of the cloud storage container | ||
|
||
- `Authorization type`: | ||
|
||
- [`Account name and SAS token`](https://docs.microsoft.com/en-us/azure/cognitive-services/translator/document-translation/create-sas-tokens?tabs=blobs): | ||
|
||
- `Account name` | ||
- `SAS token` | ||
|
||
- [`Anonymous access`](https://docs.microsoft.com/en-us/azure/storage/blobs/anonymous-read-access-configure?tabs=portal) | ||
- `Account name` | ||
|
||
</br> | ||
- `Manifest` - the path to the manifest file on your cloud storage. | ||
You can add multiple file manifests using the `Add manifest` button. | ||
For more information click on [`?`](/docs/manual/advanced/dataset_manifest/). | ||
|
||
To publish the cloud storage, click `submit`, after which it will be available on | ||
the [Cloud storages page](/docs/manual/basics/cloud-storages/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
title: 'Cloud storages page' | ||
linkTitle: 'Cloud storages page' | ||
weight: 20 | ||
description: 'Overview of the cloud storages page.' | ||
--- | ||
|
||
![](/images/image227.jpg) | ||
|
||
The cloud storages page contains elements, each of them relating to a separate cloud storage. | ||
Each element contains: preview, cloud storage name, provider, creation and update info, status, | ||
`?` button for displaying the description and the actions menu. | ||
|
||
Each button in the action menu is responsible for a specific function: | ||
- `Update` — update this cloud storage | ||
- `Delete` — delete cloud storage. | ||
|
||
![](/images/cloud_storage_icon.jpg) | ||
|
||
This preview will appear when it is impossible to get a real preview (e.g. storage is empty or | ||
invalid credentials were used). | ||
|
||
Click the `Attach a new storage` button to [attach a new storage](/docs/manual/basics/attach-cloud-storage/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess to insert screen with real cloud storage preview. And also mention that such preview
will appear when it is impossible to get a real preview (e.g. storage is empty or invalid credentials were used)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess It's better to use svg than the screenshot. What do you think? Also, I don't see it on the website with documentation. This link was used. Am I doing something wrong?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I fixed the preview of the site, there was a mistake. I think using svg in this case is not convenient because for the correct display need to specify the css styles