Update documentation and repo links after transfer to the cvat-ai org…

…anization (cvat-ai#7722)
traditionalgithub · Apr 5, 2024 · 6c57c03 · 6c57c03
1 parent ea47d00
commit 6c57c03
Show file tree

Hide file tree

Showing 47 changed files with 148 additions and 143 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml
@@ -8,7 +8,7 @@ body:
     options:
     - label: I searched the existing issues and did not find anything similar.
       required: true
-    - label: I read/searched [the docs](https://opencv.github.io/cvat/docs/)
+    - label: I read/searched [the docs](https://docs.cvat.ai/docs/)
       required: true
 
 - type: textarea

diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml
@@ -8,7 +8,7 @@ body:
     options:
     - label: I searched the existing issues and did not find anything similar.
       required: true
-    - label: I read/searched [the docs](https://opencv.github.io/cvat/docs/)
+    - label: I read/searched [the docs](https://docs.cvat.ai/docs/)
       required: true
 - type: textarea
   attributes:

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,7 +1,7 @@
-<!-- Raise an issue to propose your change (https://github.com/opencv/cvat/issues).
+<!-- Raise an issue to propose your change (https://github.com/cvat-ai/cvat/issues).
 It helps to avoid duplication of efforts from multiple independent contributors.
 Discuss your ideas with maintainers to be sure that changes will be approved and merged.
-Read the [Contribution guide](https://opencv.github.io/cvat/docs/contributing/). -->
+Read the [Contribution guide](https://docs.cvat.ai/docs/contributing/). -->
 
 <!-- Provide a general summary of your changes in the Title above -->
 
@@ -27,13 +27,13 @@ If you're unsure about any of these, don't hesitate to ask. We're here to help!
 - [ ] I have linked related issues (see [GitHub docs](
   https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword))
 - [ ] I have increased versions of npm packages if it is necessary
-  ([cvat-canvas](https://github.com/opencv/cvat/tree/develop/cvat-canvas#versioning),
-  [cvat-core](https://github.com/opencv/cvat/tree/develop/cvat-core#versioning),
-  [cvat-data](https://github.com/opencv/cvat/tree/develop/cvat-data#versioning) and
-  [cvat-ui](https://github.com/opencv/cvat/tree/develop/cvat-ui#versioning))
+  ([cvat-canvas](https://github.com/cvat-ai/cvat/tree/develop/cvat-canvas#versioning),
+  [cvat-core](https://github.com/cvat-ai/cvat/tree/develop/cvat-core#versioning),
+  [cvat-data](https://github.com/cvat-ai/cvat/tree/develop/cvat-data#versioning) and
+  [cvat-ui](https://github.com/cvat-ai/cvat/tree/develop/cvat-ui#versioning))
 
 ### License
 
 - [ ] I submit _my code changes_ under the same [MIT License](
-  https://github.com/opencv/cvat/blob/develop/LICENSE) that covers the project.
+  https://github.com/cvat-ai/cvat/blob/develop/LICENSE) that covers the project.
   Feel free to contact the maintainers if that's a concern.
diff --git a/CITATION.cff b/CITATION.cff
@@ -13,7 +13,7 @@ authors:
 identifiers:
   - type: doi
     value: 10.5281/zenodo.4009388
-repository-code: 'https://github.com/opencv/cvat'
+repository-code: 'https://github.com/cvat-ai/cvat'
 url: 'https://cvat.ai/'
 abstract: >-
   Annotate better with CVAT, the industry-leading

diff --git a/README.md b/README.md
@@ -28,24 +28,24 @@ or [subscribe](https://www.cvat.ai/pricing/cloud) to get unlimited data,
 organizations, autoannotations, and [Roboflow and HuggingFace integration](https://www.cvat.ai/post/integrating-hugging-face-and-roboflow-models).
 
 Or set CVAT up as a self-hosted solution:
-[Self-hosted Installation Guide](https://opencv.github.io/cvat/docs/administration/basics/installation/).
+[Self-hosted Installation Guide](https://docs.cvat.ai/docs/administration/basics/installation/).
 We provide [Enterprise support](https://www.cvat.ai/pricing/on-prem) for
 self-hosted installations with premium features: SSO, LDAP, Roboflow and
 HuggingFace integrations, and advanced analytics (coming soon). We also
 do trainings and a dedicated support with 24 hour SLA.
 
 ## Quick start ⚡
 
-- [Installation guide](https://opencv.github.io/cvat/docs/administration/basics/installation/)
-- [Manual](https://opencv.github.io/cvat/docs/manual/)
-- [Contributing](https://opencv.github.io/cvat/docs/contributing/)
+- [Installation guide](https://docs.cvat.ai/docs/administration/basics/installation/)
+- [Manual](https://docs.cvat.ai/docs/manual/)
+- [Contributing](https://docs.cvat.ai/docs/contributing/)
 - [Datumaro dataset framework](https://github.com/cvat-ai/datumaro/blob/develop/README.md)
 - [Server API](#api)
 - [Python SDK](#sdk)
 - [Command line tool](#cli)
-- [XML annotation format](https://opencv.github.io/cvat/docs/manual/advanced/xml_format/)
-- [AWS Deployment Guide](https://opencv.github.io/cvat/docs/administration/basics/aws-deployment-guide/)
-- [Frequently asked questions](https://opencv.github.io/cvat/docs/faq/)
+- [XML annotation format](https://docs.cvat.ai/docs/manual/advanced/xml_format/)
+- [AWS Deployment Guide](https://docs.cvat.ai/docs/administration/basics/aws-deployment-guide/)
+- [Frequently asked questions](https://docs.cvat.ai/docs/faq/)
 - [Where to ask questions](#where-to-ask-questions)
 
 ## Partners ❤️
@@ -80,7 +80,7 @@ This is an online version of CVAT. It's free, efficient, and easy to use.
 to 10 tasks there and upload up to 500Mb of data to annotate. It will only be
 visible to you or the people you assign to it.
 
-For now, it does not have [analytics features](https://opencv.github.io/cvat/docs/administration/advanced/analytics/)
+For now, it does not have [analytics features](https://docs.cvat.ai/docs/administration/advanced/analytics/)
 like management and monitoring the data annotation team. It also does not allow exporting images, just the annotations.
 
 We plan to enhance [cvat.ai](https://cvat.ai) with new powerful features. Stay tuned!
@@ -124,19 +124,19 @@ For feedback, please see [Contact us](#contact-us)
 
 ## API
 
-- [Documentation](https://opencv.github.io/cvat/docs/api_sdk/api/)
+- [Documentation](https://docs.cvat.ai/docs/api_sdk/api/)
 
 ## SDK
 
 - Install with `pip install cvat-sdk`
 - [PyPI package homepage](https://pypi.org/project/cvat-sdk/)
-- [Documentation](https://opencv.github.io/cvat/docs/api_sdk/sdk/)
+- [Documentation](https://docs.cvat.ai/docs/api_sdk/sdk/)
 
 ## CLI
 
 - Install with `pip install cvat-cli`
 - [PyPI package homepage](https://pypi.org/project/cvat-cli/)
-- [Documentation](https://opencv.github.io/cvat/docs/api_sdk/cli/)
+- [Documentation](https://docs.cvat.ai/docs/api_sdk/cli/)
 
 ## Supported annotation formats
 
@@ -146,14 +146,14 @@ after clicking the **Upload annotation** and **Dump annotation** buttons.
 additional dataset transformations with its command line tool and Python library.
 
 For more information about the supported formats, see:
-[Annotation Formats](https://opencv.github.io/cvat/docs/manual/advanced/formats/).
+[Annotation Formats](https://docs.cvat.ai/docs/manual/advanced/formats/).
 
 <!--lint disable maximum-line-length-->
 
 | Annotation format                                                                                | Import | Export |
 | ------------------------------------------------------------------------------------------------ | ------ | ------ |
-| [CVAT for images](https://opencv.github.io/cvat/docs/manual/advanced/xml_format/#annotation)     | ✔️     | ✔️     |
-| [CVAT for a video](https://opencv.github.io/cvat/docs/manual/advanced/xml_format/#interpolation) | ✔️     | ✔️     |
+| [CVAT for images](https://docs.cvat.ai/docs/manual/advanced/xml_format/#annotation)     | ✔️     | ✔️     |
+| [CVAT for a video](https://docs.cvat.ai/docs/manual/advanced/xml_format/#interpolation) | ✔️     | ✔️     |
 | [Datumaro](https://github.com/cvat-ai/datumaro)                                                  | ✔️     | ✔️     |
 | [PASCAL VOC](http://host.robots.ox.ac.uk/pascal/VOC/)                                            | ✔️     | ✔️     |
 | Segmentation masks from [PASCAL VOC](http://host.robots.ox.ac.uk/pascal/VOC/)                    | ✔️     | ✔️     |
@@ -256,8 +256,8 @@ questions and get our support.
 [docker-server-image-url]: https://hub.docker.com/r/cvat/server
 [docker-ui-pulls-img]: https://img.shields.io/docker/pulls/cvat/ui.svg?style=flat-square&label=UI%20pulls
 [docker-ui-image-url]: https://hub.docker.com/r/cvat/ui
-[ci-img]: https://github.com/opencv/cvat/actions/workflows/main.yml/badge.svg?branch=develop
-[ci-url]: https://github.com/opencv/cvat/actions
+[ci-img]: https://github.com/cvat-ai/cvat/actions/workflows/main.yml/badge.svg?branch=develop
+[ci-url]: https://github.com/cvat-ai/cvat/actions
 [gitter-img]: https://img.shields.io/gitter/room/opencv-cvat/public?style=flat
 [gitter-url]: https://gitter.im/opencv-cvat/public
 [coverage-img]: https://codecov.io/github/opencv/cvat/branch/develop/graph/badge.svg

diff --git a/changelog.d/20240403_181532_roman_update_urls.md b/changelog.d/20240403_181532_roman_update_urls.md
@@ -0,0 +1,5 @@
+### Changed
+
+- Updated links to the documentation website to point to the new domain,
+  `docs.cvat.ai`
+  (<https://github.com/cvat-ai/cvat/pull/7722>)
diff --git a/changelog.d/fragment.j2 b/changelog.d/fragment.j2
@@ -1,4 +1,4 @@
 ### {{ config.categories | join('|') }} <!-- pick one -->
 
 - Describe your change here...
-  (<https://github.com/opencv/cvat/pull/XXXX>)
+  (<https://github.com/cvat-ai/cvat/pull/XXXX>)
diff --git a/cvat-sdk/README.md b/cvat-sdk/README.md
@@ -10,7 +10,7 @@ The SDK API includes several layers:
 - PyTorch adapter. Located at `cvat_sdk.pytorch`.
 * Auto-annotation support. Located at `cvat_sdk.auto_annotation`.
 
-Package documentation is available [here](https://opencv.github.io/cvat/docs/api_sdk/sdk).
+Package documentation is available [here](https://docs.cvat.ai/docs/api_sdk/sdk).
 
 ## Installation & Usage
 
@@ -26,7 +26,7 @@ To use the PyTorch adapter, request the `pytorch` extra:
 pip install "cvat-sdk[pytorch]"
 ```
 
-To install from the local directory, follow [the developer guide](https://opencv.github.io/cvat/docs/api_sdk/sdk/developer_guide).
+To install from the local directory, follow [the developer guide](https://docs.cvat.ai/docs/api_sdk/sdk/developer_guide).
 
 After installation you can import the package:
 

diff --git a/cvat-sdk/gen/templates/openapi-generator/api_doc.mustache b/cvat-sdk/gen/templates/openapi-generator/api_doc.mustache
@@ -38,7 +38,7 @@ Name | Type | Description  | Notes
 {{/optionalParams}}
 
 There are also optional kwargs that control the function invocation behavior.
-[Read more here](https://opencv.github.io/cvat/docs/api_sdk/sdk/lowlevel-api/#sending-requests).
+[Read more here](https://docs.cvat.ai/docs/api_sdk/sdk/lowlevel-api/#sending-requests).
 
 ### Returned values
 
@@ -49,7 +49,7 @@ Returns a tuple with 2 values: `({{#returnType}}parsed_response{{/returnType}}{{
 {{#returnType}}The first value is a model parsed from the response data.{{/returnType}}{{^returnType}}This endpoint does not have any return value, so `None` is always returned as the first value.{{/returnType}}
 The second value is the raw response, which can be useful to get response parameters, such as
 status code, headers, or raw response data. Read more about invocation parameters
-and returned values [here](https://opencv.github.io/cvat/docs/api_sdk/sdk/lowlevel-api/#sending-requests).
+and returned values [here](https://docs.cvat.ai/docs/api_sdk/sdk/lowlevel-api/#sending-requests).
 
 ### Authorization
 

diff --git a/cvat-ui/README.md b/cvat-ui/README.md
@@ -36,5 +36,5 @@ yarn run build
 yarn run build --mode=development     # without a minification
 ```
 
-Important: You also have to run CVAT REST API server (please read `https://opencv.github.io/cvat/docs/contributing/`)
+Important: You also have to run CVAT REST API server (please read `https://docs.cvat.ai/docs/contributing/`)
 to correct working since UI gets all necessary data (tasks, users, annotations) from there
diff --git a/.../components/annotation-page/standard-workspace/objects-side-bar/object-item-attribute.tsx b/.../components/annotation-page/standard-workspace/objects-side-bar/object-item-attribute.tsx
@@ -58,7 +58,7 @@ function ItemAttributeComponent(props: Props): JSX.Element {
     useEffect(() => {
         // wrap to internal use effect to avoid issues
         // with chinese keyboard
-        // https://github.com/opencv/cvat/pull/6916
+        // https://github.com/cvat-ai/cvat/pull/6916
         if (localAttrValue !== attrValue) {
             changeAttribute(attrID, localAttrValue);
         }

diff --git a/cvat-ui/src/config.tsx b/cvat-ui/src/config.tsx
@@ -7,19 +7,19 @@ import React from 'react';
 
 const NO_BREAK_SPACE = '\u00a0';
 const UNDEFINED_ATTRIBUTE_VALUE = '__undefined__';
-const CHANGELOG_URL = 'https://github.com/opencv/cvat/blob/develop/CHANGELOG.md';
-const LICENSE_URL = 'https://github.com/opencv/cvat/blob/develop/LICENSE';
+const CHANGELOG_URL = 'https://github.com/cvat-ai/cvat/blob/develop/CHANGELOG.md';
+const LICENSE_URL = 'https://github.com/cvat-ai/cvat/blob/develop/LICENSE';
 const DISCORD_URL = 'https://discord.gg/fNR3eXfk6C';
-const GITHUB_URL = 'https://github.com/opencv/cvat';
-const GITHUB_IMAGE_URL = 'https://github.com/opencv/cvat/raw/develop/site/content/en/images/cvat.jpg';
-const GUIDE_URL = 'https://opencv.github.io/cvat/docs';
-const UPGRADE_GUIDE_URL = 'https://opencv.github.io/cvat/docs/administration/advanced/upgrade_guide';
+const GITHUB_URL = 'https://github.com/cvat-ai/cvat';
+const GITHUB_IMAGE_URL = 'https://github.com/cvat-ai/cvat/raw/develop/site/content/en/images/cvat.jpg';
+const GUIDE_URL = 'https://docs.cvat.ai/docs';
+const UPGRADE_GUIDE_URL = 'https://docs.cvat.ai/docs/administration/advanced/upgrade_guide';
 const SHARE_MOUNT_GUIDE_URL =
-    'https://opencv.github.io/cvat/docs/administration/basics/installation/#share-path';
+    'https://docs.cvat.ai/docs/administration/basics/installation/#share-path';
 const NUCLIO_GUIDE =
-    'https://opencv.github.io/cvat//docs/administration/advanced/installation_automatic_annotation/';
-const FILTERS_GUIDE_URL = 'https://opencv.github.io/cvat/docs/manual/advanced/filter/';
-const DATASET_MANIFEST_GUIDE_URL = 'https://opencv.github.io/cvat/docs/manual/advanced/dataset_manifest/';
+    'https://docs.cvat.ai//docs/administration/advanced/installation_automatic_annotation/';
+const FILTERS_GUIDE_URL = 'https://docs.cvat.ai/docs/manual/advanced/filter/';
+const DATASET_MANIFEST_GUIDE_URL = 'https://docs.cvat.ai/docs/manual/advanced/dataset_manifest/';
 const CANVAS_BACKGROUND_COLORS = ['#ffffff', '#f1f1f1', '#e5e5e5', '#d8d8d8', '#CCCCCC', '#B3B3B3', '#999999'];
 const NEW_LABEL_COLOR = '#b3b3b3';
 const LATEST_COMMENTS_SHOWN_QUICK_ISSUE = 3;
@@ -31,7 +31,7 @@ const CANVAS_WORKSPACE_COLS = 12;
 const CANVAS_WORKSPACE_MARGIN = 8;
 const CANVAS_WORKSPACE_DEFAULT_CONTEXT_HEIGHT = 4;
 const CANVAS_WORKSPACE_PADDING = CANVAS_WORKSPACE_MARGIN / 2;
-const OUTSIDE_PIC_URL = 'https://opencv.github.io/cvat/images/image019.jpg';
+const OUTSIDE_PIC_URL = 'https://docs.cvat.ai/images/image019.jpg';
 const DEFAULT_AWS_S3_REGIONS: string[][] = [
     ['us-east-1', 'US East (N. Virginia)'],
     ['us-east-2', 'US East (Ohio)'],

diff --git a/cvat/apps/dataset_manager/project.py b/cvat/apps/dataset_manager/project.py
@@ -26,7 +26,7 @@ def export_project(project_id, dst_file, format_name,
     # we dont need to acquire lock after the task has been initialized from DB.
     # But there is the bug with corrupted dump file in case 2 or
     # more dump request received at the same time:
-    # https://github.com/opencv/cvat/issues/217
+    # https://github.com/cvat-ai/cvat/issues/217
     with transaction.atomic():
         project = ProjectAnnotationAndData(project_id)
         project.init_from_db()

diff --git a/cvat/apps/dataset_manager/task.py b/cvat/apps/dataset_manager/task.py
@@ -851,7 +851,7 @@ def export_job(job_id, dst_file, format_name, server_url=None, save_images=False
     # we dont need to acquire lock after the task has been initialized from DB.
     # But there is the bug with corrupted dump file in case 2 or
     # more dump request received at the same time:
-    # https://github.com/opencv/cvat/issues/217
+    # https://github.com/cvat-ai/cvat/issues/217
     with transaction.atomic():
         job = JobAnnotation(job_id)
         job.init_from_db()
@@ -900,7 +900,7 @@ def export_task(task_id, dst_file, format_name, server_url=None, save_images=Fal
     # we dont need to acquire lock after the task has been initialized from DB.
     # But there is the bug with corrupted dump file in case 2 or
     # more dump request received at the same time:
-    # https://github.com/opencv/cvat/issues/217
+    # https://github.com/cvat-ai/cvat/issues/217
     with transaction.atomic():
         task = TaskAnnotation(task_id)
         task.init_from_db()

diff --git a/cvat/apps/engine/media_extractors.py b/cvat/apps/engine/media_extractors.py
@@ -754,10 +754,10 @@ def _add_video_stream(self, container, w, h, rate, options):
         if w % 2:
             w += 1
 
-        # libopenh264 has 4K limitations, https://github.com/opencv/cvat/issues/7425
+        # libopenh264 has 4K limitations, https://github.com/cvat-ai/cvat/issues/7425
         if h * w > (self.MAX_MBS_PER_FRAME << 8):
             raise ValidationError(
-                'The video codec being used does not support such high video resolution, refer https://github.com/opencv/cvat/issues/7425'
+                'The video codec being used does not support such high video resolution, refer https://github.com/cvat-ai/cvat/issues/7425'
             )
 
         video_stream = container.add_stream(self._codec_name, rate=rate)

diff --git a/cvat/apps/engine/models.py b/cvat/apps/engine/models.py
@@ -496,7 +496,7 @@ class Meta:
         unique_together = ("data", "file")
 
         # Some DBs can shuffle the rows. Here we restore the insertion order.
-        # https://github.com/opencv/cvat/pull/5083#discussion_r1038032715
+        # https://github.com/cvat-ai/cvat/pull/5083#discussion_r1038032715
         ordering = ('id', )
 
 # For server files on the mounted share
@@ -509,7 +509,7 @@ class Meta:
         unique_together = ("data", "file")
 
         # Some DBs can shuffle the rows. Here we restore the insertion order.
-        # https://github.com/opencv/cvat/pull/5083#discussion_r1038032715
+        # https://github.com/cvat-ai/cvat/pull/5083#discussion_r1038032715
         ordering = ('id', )
 
 # For URLs
@@ -522,7 +522,7 @@ class Meta:
         unique_together = ("data", "file")
 
         # Some DBs can shuffle the rows. Here we restore the insertion order.
-        # https://github.com/opencv/cvat/pull/5083#discussion_r1038032715
+        # https://github.com/cvat-ai/cvat/pull/5083#discussion_r1038032715
         ordering = ('id', )
 
 
@@ -537,7 +537,7 @@ class Meta:
         unique_together = ("data", "path")
 
         # Some DBs can shuffle the rows. Here we restore the insertion order.
-        # https://github.com/opencv/cvat/pull/5083#discussion_r1038032715
+        # https://github.com/cvat-ai/cvat/pull/5083#discussion_r1038032715
         ordering = ('id', )
 
 

diff --git a/cvat/apps/engine/serializers.py b/cvat/apps/engine/serializers.py
@@ -673,7 +673,7 @@ def create(self, validated_data):
 
                 if seed is not None and frame_count < size:
                     # Reproduce the old (a little bit incorrect) behavior that existed before
-                    # https://github.com/opencv/cvat/pull/7126
+                    # https://github.com/cvat-ai/cvat/pull/7126
                     # to make the old seed-based sequences reproducible
                     valid_frame_ids = [v for v in valid_frame_ids if v != task.data.stop_frame]
 
@@ -855,7 +855,7 @@ def __init__(self, *args, **kwargs):
 class DataSerializer(serializers.ModelSerializer):
     """
     Read more about parameters here:
-    https://opencv.github.io/cvat/docs/manual/basics/create_an_annotation_task/#advanced-configuration
+    https://docs.cvat.ai/docs/manual/basics/create_an_annotation_task/#advanced-configuration
     """
 
     image_quality = serializers.IntegerField(min_value=0, max_value=100,
@@ -900,7 +900,7 @@ class DataSerializer(serializers.ModelSerializer):
     use_cache = serializers.BooleanField(default=False,
         help_text=textwrap.dedent("""\
             Enable or disable task data chunk caching for the task.
-            Read more: https://opencv.github.io/cvat/docs/manual/advanced/data_on_fly/
+            Read more: https://docs.cvat.ai/docs/manual/advanced/data_on_fly/
         """))
     copy_data = serializers.BooleanField(default=False, help_text=textwrap.dedent("""\
             Copy data from the server file share to CVAT during the task creation.