From 545e778e9621c4c30b7cfd5d76e3bc127701a3b2 Mon Sep 17 00:00:00 2001 From: William Schmitt <11043108+W-Schmitt@users.noreply.github.com> Date: Mon, 29 Aug 2022 18:53:58 +0200 Subject: [PATCH] fix: docs url (#4877) Co-authored-by: William Schmitt --- README.md | 28 +++++++++---------- cvat-ui/README.md | 2 +- .../manifests-manager.tsx | 2 +- cvat-ui/src/consts.ts | 6 ++-- cvat/settings/base.py | 2 +- utils/README.md | 2 +- 6 files changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 3570146b..f7e3c0bf 100644 --- a/README.md +++ b/README.md @@ -21,21 +21,21 @@ organizations around the world to solve real problems using the Data-centric AI approach. Start using CVAT online for free: [cvat.ai](https://cvat.ai). Or set it up as a self-hosted solution: -[read here](https://cvat-ai.github.io/cvat/docs/administration/basics/installation/). +[read here](https://opencv.github.io/cvat/docs/administration/basics/installation/). ![CVAT screencast](site/content/en/images/cvat-ai-screencast.gif) ## Quick start ⚡ -- [Installation guide](https://cvat-ai.github.io/cvat/docs/administration/basics/installation/) -- [Manual](https://cvat-ai.github.io/cvat/docs/manual/) -- [Contributing](https://cvat-ai.github.io/cvat/docs/contributing/) -- [Django REST API documentation](https://cvat-ai.github.io/cvat/docs/administration/basics/rest_api_guide/) +- [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/) +- [Django REST API documentation](https://opencv.github.io/cvat/docs/administration/basics/rest_api_guide/) - [Datumaro dataset framework](https://github.com/cvat-ai/datumaro/blob/develop/README.md) -- [Command line interface](https://cvat-ai.github.io/cvat/docs/manual/advanced/cli/) -- [XML annotation format](https://cvat-ai.github.io/cvat/docs/manual/advanced/xml_format/) -- [AWS Deployment Guide](https://cvat-ai.github.io/cvat/docs/administration/basics/aws-deployment-guide/) -- [Frequently asked questions](https://cvat-ai.github.io/cvat/docs/faq/) +- [Command line interface](https://opencv.github.io/cvat/docs/manual/advanced/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/) - [Where to ask questions](#where-to-ask-questions) ## Partners ❤️ @@ -71,7 +71,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 people you assign to it. -For now, it does not have [analytics features](https://cvat-ai.github.io/cvat/docs/administration/advanced/analytics/) +For now, it does not have [analytics features](https://opencv.github.io/cvat/docs/administration/advanced/analytics/) like management and monitoring the data annotation team. We plan to enhance [cvat.ai](https://cvat.ai) with new powerful features. Stay tuned! @@ -87,7 +87,7 @@ The images have been downloaded more than 1M times so far. ## REST API -CVAT has a REST API: [documentation](https://cvat-ai.github.io/cvat/docs/administration/basics/rest_api_guide/). +CVAT has a REST API: [documentation](https://opencv.github.io/cvat/docs/administration/basics/rest_api_guide/). Its current version is `2.0-alpha`. We focus on its improvement, and the API may be changed in the next releases. ## Screencasts 🎦 @@ -112,14 +112,14 @@ dataset framework allows additional dataset transformations via its command line tool and Python library. For more information about the supported formats, look at the -[documentation](https://cvat-ai.github.io/cvat/docs/manual/advanced/formats/). +[documentation](https://opencv.github.io/cvat/docs/manual/advanced/formats/). | Annotation format | Import | Export | | --------------------------------------------------------------------------------------------------------- | ------ | ------ | -| [CVAT for images](https://cvat-ai.github.io/cvat/docs/manual/advanced/xml_format/#annotation) | ✔️ | ✔️ | -| [CVAT for a video](https://cvat-ai.github.io/cvat/docs/manual/advanced/xml_format/#interpolation) | ✔️ | ✔️ | +| [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) | ✔️ | ✔️ | | [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/) | ✔️ | ✔️ | diff --git a/cvat-ui/README.md b/cvat-ui/README.md index 39e791a8..b89fc644 100644 --- 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://cvat-ai.github.io/cvat/docs/contributing/`) +Important: You also have to run CVAT REST API server (please read `https://opencv.github.io/cvat/docs/contributing/`) to correct working since UI gets all necessary data (tasks, users, annotations) from there diff --git a/cvat-ui/src/components/create-cloud-storage-page/manifests-manager.tsx b/cvat-ui/src/components/create-cloud-storage-page/manifests-manager.tsx index a650f46f..c2a6e285 100644 --- a/cvat-ui/src/components/create-cloud-storage-page/manifests-manager.tsx +++ b/cvat-ui/src/components/create-cloud-storage-page/manifests-manager.tsx @@ -80,7 +80,7 @@ export default function ManifestsManager(props: Props): JSX.Element { type='link' target='_blank' className='cvat-cloud-storage-help-button' - href='https://cvat-ai.github.io/cvat/docs/manual/advanced/dataset_manifest/' + href='https://opencv.github.io/cvat/docs/manual/advanced/dataset_manifest/' > diff --git a/cvat-ui/src/consts.ts b/cvat-ui/src/consts.ts index 7ff346d1..4c6fc1c2 100644 --- a/cvat-ui/src/consts.ts +++ b/cvat-ui/src/consts.ts @@ -11,11 +11,11 @@ const GITTER_PUBLIC_URL = 'https://gitter.im/opencv-cvat/public'; const FORUM_URL = 'https://software.intel.com/en-us/forums/intel-distribution-of-openvino-toolkit'; 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://cvat-ai.github.io/cvat/docs'; +const GUIDE_URL = 'https://opencv.github.io/cvat/docs'; const SHARE_MOUNT_GUIDE_URL = - 'https://cvat-ai.github.io/cvat/docs/administration/basics/installation/#share-path'; + 'https://opencv.github.io/cvat/docs/administration/basics/installation/#share-path'; const NUCLIO_GUIDE = - 'https://cvat-ai.github.io/cvat//docs/administration/advanced/installation_automatic_annotation/'; + 'https://opencv.github.io/cvat//docs/administration/advanced/installation_automatic_annotation/'; const CANVAS_BACKGROUND_COLORS = ['#ffffff', '#f1f1f1', '#e5e5e5', '#d8d8d8', '#CCCCCC', '#B3B3B3', '#999999']; const NEW_LABEL_COLOR = '#b3b3b3'; const LATEST_COMMENTS_SHOWN_QUICK_ISSUE = 3; diff --git a/cvat/settings/base.py b/cvat/settings/base.py index 5103d843..3b570c7f 100644 --- a/cvat/settings/base.py +++ b/cvat/settings/base.py @@ -535,7 +535,7 @@ SPECTACULAR_SETTINGS = { 'TOS': 'https://www.google.com/policies/terms/', 'EXTERNAL_DOCS': { 'description': 'CVAT documentation', - 'url': 'https://cvat-ai.github.io/cvat/docs/', + 'url': 'https://opencv.github.io/cvat/docs/', }, # OTHER SETTINGS # https://drf-spectacular.readthedocs.io/en/latest/settings.html diff --git a/utils/README.md b/utils/README.md index 7e6ed829..2f85e05d 100644 --- a/utils/README.md +++ b/utils/README.md @@ -5,4 +5,4 @@ This folder contains some useful utilities for Computer Vision Annotation Tool (CVAT). To read about a certain utility please choose a link: -- [Command line interface for working with CVAT tasks](https://cvat-ai.github.io/cvat/docs/manual/advanced/cli/) +- [Command line interface for working with CVAT tasks](https://opencv.github.io/cvat/docs/manual/advanced/cli/)