Documentation update, added info about the cloud storage UI #3724

amotovx · 2021-09-24T11:44:22Z

Motivation and context

Related to #3372

This PR adds an overview page for the Cloud storage tab and instructions on attaching cloud storage using the UI to the Basics section of the manual. The creating an annotation task page has also been updated to reflect the changes.

How has this been tested?

Checklist

I submit my changes into the develop branch
I have added description of my changes into CHANGELOG file
I have updated the documentation accordingly
I have added tests to cover my changes
I have linked related issues (read 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.
I have updated the license header for each file (see an example below)

# Copyright (C) 2021 Intel Corporation
#
# SPDX-License-Identifier: MIT

TOsmanov · 2021-09-24T12:17:22Z

site/content/en/docs/manual/basics/attach-cloud-storage.md

+title: 'Attach cloud storage'
+linkTitle: 'Attach cloud storage'
+weight: 21
+description: ''


Suggested change

description: ''

description: 'Instructions on how to attach cloud storage with use UI.'

TOsmanov · 2021-09-24T12:17:27Z

site/content/en/docs/manual/basics/attach-cloud-storage.md

+
+  - [AWS-S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/GetStartedWithS3.html):
+
+    - `Bucket` - container name cloud storage


Suggested change

- `Bucket` - container name cloud storage

- `Bucket` - cloud storage bucket name

TOsmanov · 2021-09-24T12:17:30Z

site/content/en/docs/manual/basics/attach-cloud-storage.md

+
+    </br>
+- `Manifest` - the path to the manifest file on your cloud storage.
+You can add multiple file manifests using the add manifest button.


Suggested change

You can add multiple file manifests using the add manifest button.

You can add multiple file manifests using the `Add manifest` button.

TOsmanov · 2021-09-24T12:17:34Z

site/content/en/docs/manual/basics/creating_an_annotation_task.md

@@ -76,6 +76,8 @@ If you select tab `Connected file share` you can choose files for annotation fro
 If you select ` Remote source` , you'll see a field where you can enter a list of URLs (one URL per line).
 If you upload a video or dataset with images and select `Use cache` option, you can attach a `manifest.jsonl` file.
 You can find how to prepare it [here](/docs/manual/advanced/dataset_manifest/).
+If you select the 'Cloud Storage' tab, you can select a cloud storage (for this type the cloud storage name),


Suggested change

If you select the 'Cloud Storage' tab, you can select a cloud storage (for this type the cloud storage name),

If you select the `Cloud Storage` tab, you can select a cloud storage (for this type the cloud storage name),

TOsmanov · 2021-09-24T12:29:34Z

Preview:
https://tosmanov.github.io/cvat/docs/manual/basics/creating_an_annotation_task/
https://tosmanov.github.io/cvat/docs/manual/basics/cloud-storages/
https://tosmanov.github.io/cvat/docs/manual/basics/attach-cloud-storage/

site/content/en/docs/manual/basics/cloud-storages.md

site/content/en/docs/manual/basics/creating_an_annotation_task.md

Co-authored-by: Timur Osmanov <[email protected]>

nmanovic · 2021-09-24T14:30:28Z

site/content/en/docs/manual/basics/attach-cloud-storage.md

+description: 'Instructions on how to attach cloud storage using UI'
+---
+
+In CVAT you can use AWS-S3 and Azur Blob Container cloud storages to store image datasets for your tasks.


Can we prepare a tutorial here? Let's try to create "AWS account", "load images to S3", "prepare the manifest", "load manifest to S3", "use the storage to create tasks on CVAT.

Users should be able to reproduce our steps. For now we have only description for the complex process.

It is also a good idea to get a pubic dataset for the purpose.

Marishka17 · 2021-09-27T09:28:33Z

site/content/en/docs/manual/basics/attach-cloud-storage.md

+You can mount the cloud storage using command line interface. More information is available on the
+[Mounting cloud storage](/docs/administration/advanced/mounting_cloud_storages) page.


It does not correspond to the current functionality and it may mislead a user that the created cloud storage will appear on the page with cloud storages, but it is not like that. So I guess to remove this.

Marishka17 · 2021-09-27T09:28:42Z

site/content/en/docs/manual/basics/attach-cloud-storage.md

+          - `Account name`
+          - `SAS token`
+
+        - [`Anonymous access`](https://docs.microsoft.com/en-us/azure/storage/blobs/anonymous-read-access-prevent)


Suggested change

- [`Anonymous access`](https://docs.microsoft.com/en-us/azure/storage/blobs/anonymous-read-access-prevent)

- [`Anonymous access`](https://docs.microsoft.com/en-us/azure/storage/blobs/anonymous-read-access-configure?tabs=portal)

Marishka17 · 2021-09-29T07:39:23Z

@amotovx , Hi, what the current status of the PR?

Marishka17

I have only one small comment. Could you please fix it? and I will approve the PR.

Marishka17 · 2021-10-01T09:06:41Z

site/content/en/docs/manual/basics/cloud-storages.md

+description: 'Overview of the cloud storages page.'
+---
+
+![](/images/image227.jpg)


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)

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?

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

nmanovic · 2021-10-04T08:56:11Z

@dmitriikhurtin , could you please confirm that all issues with tests in the PR are known?

added info about cloud storage ui

d2d1806

amotovx requested a review from nmanovic as a code owner September 24, 2021 11:44

amotovx added 2 commits September 24, 2021 14:55

fixed linter errors, improved list spacing

086dec0

fixed linter errors v2

0d60a1c

TOsmanov suggested changes Sep 24, 2021

View reviewed changes

fixed mistakes & indentation

075a87e

TOsmanov suggested changes Sep 24, 2021

View reviewed changes

site/content/en/docs/manual/basics/cloud-storages.md Outdated Show resolved Hide resolved

site/content/en/docs/manual/basics/creating_an_annotation_task.md Show resolved Hide resolved

Apply suggestions from code review

61dc224

Co-authored-by: Timur Osmanov <[email protected]>

nmanovic reviewed Sep 24, 2021

View reviewed changes

amotovx added 2 commits September 27, 2021 09:43

fixed errors & indentation issues

b15edf9

fixed errors & indentation issues v2

3e978d7

Marishka17 reviewed Sep 27, 2021

View reviewed changes

apply suggestions v2

b34e1bd

bsekachev assigned Marishka17 Sep 29, 2021

TOsmanov mentioned this pull request Sep 29, 2021

Documentation update, added info about the cloud storage UI and add AWS-S3 tutorial #3745

Merged

8 tasks

Marishka17 reviewed Oct 1, 2021

View reviewed changes

update preview image, add info about preview icon

b77f497

Marishka17 approved these changes Oct 4, 2021

View reviewed changes

nmanovic merged commit 4d8172c into cvat-ai:develop Oct 4, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Documentation update, added info about the cloud storage UI #3724

Documentation update, added info about the cloud storage UI #3724

amotovx commented Sep 24, 2021

TOsmanov Sep 24, 2021

TOsmanov Sep 24, 2021

TOsmanov Sep 24, 2021

TOsmanov Sep 24, 2021

TOsmanov commented Sep 24, 2021

nmanovic Sep 24, 2021

nmanovic Sep 24, 2021

nmanovic Sep 24, 2021

Marishka17 Sep 27, 2021

Marishka17 Sep 27, 2021

Marishka17 commented Sep 29, 2021

Marishka17 left a comment

Marishka17 Oct 1, 2021

Marishka17 Oct 4, 2021

TOsmanov Oct 4, 2021 •

edited

Loading

nmanovic commented Oct 4, 2021

	description: ''
	description: 'Instructions on how to attach cloud storage with use UI.'


		- [AWS-S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/GetStartedWithS3.html):

		- `Bucket` - container name cloud storage

	- `Bucket` - container name cloud storage
	- `Bucket` - cloud storage bucket name

	You can add multiple file manifests using the add manifest button.
	You can add multiple file manifests using the `Add manifest` button.

	If you select the 'Cloud Storage' tab, you can select a cloud storage (for this type the cloud storage name),
	If you select the `Cloud Storage` tab, you can select a cloud storage (for this type the cloud storage name),

		You can mount the cloud storage using command line interface. More information is available on the
		[Mounting cloud storage](/docs/administration/advanced/mounting_cloud_storages) page.

	- [`Anonymous access`](https://docs.microsoft.com/en-us/azure/storage/blobs/anonymous-read-access-prevent)
	- [`Anonymous access`](https://docs.microsoft.com/en-us/azure/storage/blobs/anonymous-read-access-configure?tabs=portal)

Documentation update, added info about the cloud storage UI #3724

Documentation update, added info about the cloud storage UI #3724

Conversation

amotovx commented Sep 24, 2021

Motivation and context

How has this been tested?

Checklist

License

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TOsmanov commented Sep 24, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Marishka17 commented Sep 29, 2021

Marishka17 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TOsmanov Oct 4, 2021 • edited Loading

Choose a reason for hiding this comment

nmanovic commented Oct 4, 2021

TOsmanov Oct 4, 2021 •

edited

Loading