From f66212604473a5f65561e002091c1065b8de5656 Mon Sep 17 00:00:00 2001 From: Timur Osmanov <54434686+TOsmanov@users.noreply.github.com> Date: Tue, 1 Jun 2021 22:04:57 +0300 Subject: [PATCH] Update documentation on website (#3265) * update documentation on website * fix markup * fix formats header * fix linter error * delete duplicate headers --- README.md | 56 ++++++++++--------- site/config.toml | 2 +- site/content/en/_index.html | 4 +- site/content/en/about/_index.html | 22 ++++---- site/content/en/docs/_index.md | 2 +- .../en/docs/for-users/formats/_index.md | 18 ++++++ .../format-camvid.md | 0 .../format-coco.md | 0 .../format-cvat.md | 0 .../format-datumaro.md | 0 .../format-icdar.md | 0 .../format-imagenet.md | 0 .../format-labelme.md | 0 .../format-market1501.md | 0 .../{format-specifications => }/format-mot.md | 0 .../format-mots.md | 0 .../formats/format-specifications/_index.md | 22 -------- .../format-tfrecord.md | 0 .../format-vggface2.md | 0 .../{format-specifications => }/format-voc.md | 0 .../format-widerface.md | 0 .../format-yolo.md | 0 .../content/en/docs/for-users/installation.md | 10 ++-- .../advanced/track-mode-advanced.md | 2 +- .../en/docs/for-users/user-guide/models.md | 2 - .../en/docs/for-users/user-guide/search.md | 1 - site/layouts/partials/navbar.html | 35 ++++++++++++ 27 files changed, 104 insertions(+), 72 deletions(-) rename site/content/en/docs/for-users/formats/{format-specifications => }/format-camvid.md (100%) rename site/content/en/docs/for-users/formats/{format-specifications => }/format-coco.md (100%) rename site/content/en/docs/for-users/formats/{format-specifications => }/format-cvat.md (100%) rename site/content/en/docs/for-users/formats/{format-specifications => }/format-datumaro.md (100%) rename site/content/en/docs/for-users/formats/{format-specifications => }/format-icdar.md (100%) rename site/content/en/docs/for-users/formats/{format-specifications => }/format-imagenet.md (100%) rename site/content/en/docs/for-users/formats/{format-specifications => }/format-labelme.md (100%) rename site/content/en/docs/for-users/formats/{format-specifications => }/format-market1501.md (100%) rename site/content/en/docs/for-users/formats/{format-specifications => }/format-mot.md (100%) rename site/content/en/docs/for-users/formats/{format-specifications => }/format-mots.md (100%) delete mode 100644 site/content/en/docs/for-users/formats/format-specifications/_index.md rename site/content/en/docs/for-users/formats/{format-specifications => }/format-tfrecord.md (100%) rename site/content/en/docs/for-users/formats/{format-specifications => }/format-vggface2.md (100%) rename site/content/en/docs/for-users/formats/{format-specifications => }/format-voc.md (100%) rename site/content/en/docs/for-users/formats/{format-specifications => }/format-widerface.md (100%) rename site/content/en/docs/for-users/formats/{format-specifications => }/format-yolo.md (100%) create mode 100644 site/layouts/partials/navbar.html diff --git a/README.md b/README.md index 0ed379a41..62836bc2c 100644 --- a/README.md +++ b/README.md @@ -17,14 +17,14 @@ annotation team. Try it online [cvat.org](https://cvat.org). ## Documentation -- [Installation guide](site/content/en/docs/for-users/installation.md) +- [Installation guide](https://openvinotoolkit.github.io/cvat/docs/for-users/installation/) - [User's guide](https://openvinotoolkit.github.io/cvat/docs/for-users/user-guide/) - [Django REST API documentation](#rest-api) - [Datumaro dataset framework](https://github.com/openvinotoolkit/datumaro/blob/develop/README.md) -- [Command line interface](site/content/en/docs/for-developers/cli.md) -- [XML annotation format](site/content/en/docs/for-developers/xml_format.md) -- [AWS Deployment Guide](site/content/en/docs/for-developers/AWS-Deployment-Guide.md) -- [Frequently asked questions](site/content/en/docs/for-users/faq.md) +- [Command line interface](https://openvinotoolkit.github.io/cvat/docs/for-developers/cli/) +- [XML annotation format](https://openvinotoolkit.github.io/cvat/docs/for-developers/xml_format/) +- [AWS Deployment Guide](https://openvinotoolkit.github.io/cvat/docs/for-developers/aws-deployment-guide/) +- [Frequently asked questions](https://openvinotoolkit.github.io/cvat/docs/for-users/faq/) - [Questions](#questions) ## Screencasts @@ -47,26 +47,30 @@ dataset framework allows additional dataset transformations via its command line tool and Python library. For more information about supported formats look at the -[documentation](cvat/apps/dataset_manager/formats/README.md#formats). - -| Annotation format | Import | Export | -| ----------------------------------------------------------------------------- | ------ | ------ | -| [CVAT for images](cvat/apps/documentation/xml_format.md#annotation) | X | X | -| [CVAT for a video](cvat/apps/documentation/xml_format.md#interpolation) | X | X | -| [Datumaro](https://github.com/openvinotoolkit/datumaro) | | X | -| [PASCAL VOC](http://host.robots.ox.ac.uk/pascal/VOC/) | X | X | -| Segmentation masks from [PASCAL VOC](http://host.robots.ox.ac.uk/pascal/VOC/) | X | X | -| [YOLO](https://pjreddie.com/darknet/yolo/) | X | X | -| [MS COCO Object Detection](http://cocodataset.org/#format-data) | X | X | -| [TFrecord](https://www.tensorflow.org/tutorials/load_data/tfrecord) | X | X | -| [MOT](https://motchallenge.net/) | X | X | -| [LabelMe 3.0](http://labelme.csail.mit.edu/Release3.0) | X | X | -| [ImageNet](http://www.image-net.org) | X | X | -| [CamVid](http://mi.eng.cam.ac.uk/research/projects/VideoRec/CamVid/) | X | X | -| [WIDER Face](http://shuoyang1213.me/WIDERFACE/) | X | X | -| [VGGFace2](https://github.com/ox-vgg/vgg_face2) | X | X | -| [Market-1501](https://www.aitribune.com/dataset/2018051063) | X | X | -| [ICDAR13/15](https://rrc.cvc.uab.es/?ch=2) | X | X | +[documentation](https://openvinotoolkit.github.io/cvat/docs/for-users/formats/). + + + +| Annotation format | Import | Export | +| ------------------------------------------------------------------------------------------------------- | ------ | ------ | +| [CVAT for images](https://openvinotoolkit.github.io/cvat/docs/for-developers/xml_format/#annotation) | X | X | +| [CVAT for a video](https://openvinotoolkit.github.io/cvat/docs/for-developers/xml_format/#interpolation) | X | X | +| [Datumaro](https://github.com/openvinotoolkit/datumaro) | | X | +| [PASCAL VOC](http://host.robots.ox.ac.uk/pascal/VOC/) | X | X | +| Segmentation masks from [PASCAL VOC](http://host.robots.ox.ac.uk/pascal/VOC/) | X | X | +| [YOLO](https://pjreddie.com/darknet/yolo/) | X | X | +| [MS COCO Object Detection](http://cocodataset.org/#format-data) | X | X | +| [TFrecord](https://www.tensorflow.org/tutorials/load_data/tfrecord) | X | X | +| [MOT](https://motchallenge.net/) | X | X | +| [LabelMe 3.0](http://labelme.csail.mit.edu/Release3.0) | X | X | +| [ImageNet](http://www.image-net.org) | X | X | +| [CamVid](http://mi.eng.cam.ac.uk/research/projects/VideoRec/CamVid/) | X | X | +| [WIDER Face](http://shuoyang1213.me/WIDERFACE/) | X | X | +| [VGGFace2](https://github.com/ox-vgg/vgg_face2) | X | X | +| [Market-1501](https://www.aitribune.com/dataset/2018051063) | X | X | +| [ICDAR13/15](https://rrc.cvc.uab.es/?ch=2) | X | X | + + ## Deep learning serverless functions for automatic labeling @@ -97,7 +101,7 @@ are visible to users. Disabled features: -- [Analytics: management and monitoring of data annotation team](site/content/en/docs/for-developers/analytics.md) +- [Analytics: management and monitoring of data annotation team](https://openvinotoolkit.github.io/cvat/docs/for-developers/analytics/) Limitations: diff --git a/site/config.toml b/site/config.toml index d51bb852d..390309ec3 100644 --- a/site/config.toml +++ b/site/config.toml @@ -59,7 +59,7 @@ id = "UA-00000000-0" [languages] [languages.en] -title = "" +title = "CVAT" description = "" languageName ="English" # Weight used for sorting. diff --git a/site/content/en/_index.html b/site/content/en/_index.html index 6d8c83fc6..8c5fd7a3b 100644 --- a/site/content/en/_index.html +++ b/site/content/en/_index.html @@ -1,6 +1,6 @@ +++ -title = "CVAT" -linkTitle = "CVAT" +title = "Home" +linkTitle = "Home" +++ {{< blocks/section height="full" color="docs" >}} diff --git a/site/content/en/about/_index.html b/site/content/en/about/_index.html index d65480637..91b81419c 100644 --- a/site/content/en/about/_index.html +++ b/site/content/en/about/_index.html @@ -1,5 +1,5 @@ --- -title: "About CVAT" +title: "About" linkTitle: "About" menu: main: @@ -25,40 +25,40 @@ menu:
-

2017 +

2016

- First version of CVAT was created and open sourced. + Vatic as a web-based annotation solution.
-

2018 +

2017

- Publication on GitHub. + Internal version with support for images and attributes.
-

2020 +

2018

- Release version 1.0.0. Major update.
Opening public demo-server cvat.org. + First public release on GitHub.

2020

- Release version 1.1.0.
Adding DL models. + UI based on React and AntD.
cvat.org as demo platform.

2021

- Release version 1.3.0.
Adding CVAT-3D. + Dataset as the first-class citizen.
-

2022 +

202X

- Further development... + Data platform.
diff --git a/site/content/en/docs/_index.md b/site/content/en/docs/_index.md index b98dfb6c7..26cd38229 100644 --- a/site/content/en/docs/_index.md +++ b/site/content/en/docs/_index.md @@ -1,5 +1,5 @@ --- -title: 'CVAT Documentation' +title: 'Documentation' linkTitle: 'Documentation' no_list: true menu: diff --git a/site/content/en/docs/for-users/formats/_index.md b/site/content/en/docs/for-users/formats/_index.md index 06389f1d6..126cdcc55 100644 --- a/site/content/en/docs/for-users/formats/_index.md +++ b/site/content/en/docs/for-users/formats/_index.md @@ -143,3 +143,21 @@ for parsed_shape in parsed_shapes: ) task_data.add_shape(shape) ``` + +## Format specifications + +- [CVAT](format-cvat) +- [Datumaro](format-datumaro) +- [LabelMe](format-labelme) +- [MOT](format-mot) +- [MOTS](format-mots) +- [COCO](format-coco) +- [PASCAL VOC and mask](format-voc) +- [YOLO](format-yolo) +- [TF detection API](format-tfrecord) +- [ImageNet](format-imagenet) +- [CamVid](format-camvid) +- [WIDER Face](format-widerface) +- [VGGFace2](format-vggface2) +- [Market-1501](format-market1501) +- [ICDAR13/15](format-icdar) diff --git a/site/content/en/docs/for-users/formats/format-specifications/format-camvid.md b/site/content/en/docs/for-users/formats/format-camvid.md similarity index 100% rename from site/content/en/docs/for-users/formats/format-specifications/format-camvid.md rename to site/content/en/docs/for-users/formats/format-camvid.md diff --git a/site/content/en/docs/for-users/formats/format-specifications/format-coco.md b/site/content/en/docs/for-users/formats/format-coco.md similarity index 100% rename from site/content/en/docs/for-users/formats/format-specifications/format-coco.md rename to site/content/en/docs/for-users/formats/format-coco.md diff --git a/site/content/en/docs/for-users/formats/format-specifications/format-cvat.md b/site/content/en/docs/for-users/formats/format-cvat.md similarity index 100% rename from site/content/en/docs/for-users/formats/format-specifications/format-cvat.md rename to site/content/en/docs/for-users/formats/format-cvat.md diff --git a/site/content/en/docs/for-users/formats/format-specifications/format-datumaro.md b/site/content/en/docs/for-users/formats/format-datumaro.md similarity index 100% rename from site/content/en/docs/for-users/formats/format-specifications/format-datumaro.md rename to site/content/en/docs/for-users/formats/format-datumaro.md diff --git a/site/content/en/docs/for-users/formats/format-specifications/format-icdar.md b/site/content/en/docs/for-users/formats/format-icdar.md similarity index 100% rename from site/content/en/docs/for-users/formats/format-specifications/format-icdar.md rename to site/content/en/docs/for-users/formats/format-icdar.md diff --git a/site/content/en/docs/for-users/formats/format-specifications/format-imagenet.md b/site/content/en/docs/for-users/formats/format-imagenet.md similarity index 100% rename from site/content/en/docs/for-users/formats/format-specifications/format-imagenet.md rename to site/content/en/docs/for-users/formats/format-imagenet.md diff --git a/site/content/en/docs/for-users/formats/format-specifications/format-labelme.md b/site/content/en/docs/for-users/formats/format-labelme.md similarity index 100% rename from site/content/en/docs/for-users/formats/format-specifications/format-labelme.md rename to site/content/en/docs/for-users/formats/format-labelme.md diff --git a/site/content/en/docs/for-users/formats/format-specifications/format-market1501.md b/site/content/en/docs/for-users/formats/format-market1501.md similarity index 100% rename from site/content/en/docs/for-users/formats/format-specifications/format-market1501.md rename to site/content/en/docs/for-users/formats/format-market1501.md diff --git a/site/content/en/docs/for-users/formats/format-specifications/format-mot.md b/site/content/en/docs/for-users/formats/format-mot.md similarity index 100% rename from site/content/en/docs/for-users/formats/format-specifications/format-mot.md rename to site/content/en/docs/for-users/formats/format-mot.md diff --git a/site/content/en/docs/for-users/formats/format-specifications/format-mots.md b/site/content/en/docs/for-users/formats/format-mots.md similarity index 100% rename from site/content/en/docs/for-users/formats/format-specifications/format-mots.md rename to site/content/en/docs/for-users/formats/format-mots.md diff --git a/site/content/en/docs/for-users/formats/format-specifications/_index.md b/site/content/en/docs/for-users/formats/format-specifications/_index.md deleted file mode 100644 index a12187214..000000000 --- a/site/content/en/docs/for-users/formats/format-specifications/_index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "Format specifications:" -linkTitle: "Format specifications" -weight: 1 -no_list: true ---- - -- [CVAT](format-cvat) -- [Datumaro](format-datumaro) -- [LabelMe](format-labelme) -- [MOT](format-mot) -- [MOTS](format-mots) -- [COCO](format-coco) -- [PASCAL VOC and mask](format-voc) -- [YOLO](format-yolo) -- [TF detection API](format-tfrecord) -- [ImageNet](format-imagenet) -- [CamVid](format-camvid) -- [WIDER Face](format-widerface) -- [VGGFace2](format-vggface2) -- [Market-1501](format-market1501) -- [ICDAR13/15](format-icdar) diff --git a/site/content/en/docs/for-users/formats/format-specifications/format-tfrecord.md b/site/content/en/docs/for-users/formats/format-tfrecord.md similarity index 100% rename from site/content/en/docs/for-users/formats/format-specifications/format-tfrecord.md rename to site/content/en/docs/for-users/formats/format-tfrecord.md diff --git a/site/content/en/docs/for-users/formats/format-specifications/format-vggface2.md b/site/content/en/docs/for-users/formats/format-vggface2.md similarity index 100% rename from site/content/en/docs/for-users/formats/format-specifications/format-vggface2.md rename to site/content/en/docs/for-users/formats/format-vggface2.md diff --git a/site/content/en/docs/for-users/formats/format-specifications/format-voc.md b/site/content/en/docs/for-users/formats/format-voc.md similarity index 100% rename from site/content/en/docs/for-users/formats/format-specifications/format-voc.md rename to site/content/en/docs/for-users/formats/format-voc.md diff --git a/site/content/en/docs/for-users/formats/format-specifications/format-widerface.md b/site/content/en/docs/for-users/formats/format-widerface.md similarity index 100% rename from site/content/en/docs/for-users/formats/format-specifications/format-widerface.md rename to site/content/en/docs/for-users/formats/format-widerface.md diff --git a/site/content/en/docs/for-users/formats/format-specifications/format-yolo.md b/site/content/en/docs/for-users/formats/format-yolo.md similarity index 100% rename from site/content/en/docs/for-users/formats/format-specifications/format-yolo.md rename to site/content/en/docs/for-users/formats/format-yolo.md diff --git a/site/content/en/docs/for-users/installation.md b/site/content/en/docs/for-users/installation.md index c50463cb1..5089ab9e6 100644 --- a/site/content/en/docs/for-users/installation.md +++ b/site/content/en/docs/for-users/installation.md @@ -487,7 +487,7 @@ At this point your deployment is up and running, ready for run acme-challenge fo ###### Create certificate files using an ACME challenge on docker host -####### Prepare certificates +**Prepare certificates** Point you shell in cvat repository directory, usually `cd $HOME/cvat` on docker host. @@ -507,20 +507,20 @@ If certificates is issued a successful we can test a renew: ~/.acme.sh/acme.sh --renew --force --staging -d CVAT.example.com -w $HOME/cvat/letsencrypt-webroot --debug ``` -####### Remove test certificate, if success +**Remove test certificate, if success** ``` ~/.acme.sh/acme.sh --remove -d CVAT.example.com --debug rm -r /root/.acme.sh/CVAT.example.com ``` -####### Issue a production certificate +**Issue a production certificate** ``` ~/.acme.sh/acme.sh --issue -d CVAT.example.com -w $HOME/cvat/letsencrypt-webroot --debug ``` -####### Install production certificate and a user cron job (`crontab -e`) for update it +**Install production certificate and a user cron job (`crontab -e`) for update it** This will copy necessary certificate files to a permanent directory for serve. According to acme.sh [documentation](https://github.com/acmesh-official/acme.sh#3-install-the-cert-to-apachenginx-etc) @@ -545,7 +545,7 @@ Down the cvat_proxy container for setup https with issued certificate. docker stop cvat_proxy ``` -####### Reconfigure nginx for use certificates +**Reconfigure nginx for use certificates** Bring the configuration file `$HOME/cvat/cvat_proxy/conf.d/cvat.conf.template` to the following form: diff --git a/site/content/en/docs/for-users/user-guide/advanced/track-mode-advanced.md b/site/content/en/docs/for-users/user-guide/advanced/track-mode-advanced.md index d2f5ec9cb..fbba2dbb1 100644 --- a/site/content/en/docs/for-users/user-guide/advanced/track-mode-advanced.md +++ b/site/content/en/docs/for-users/user-guide/advanced/track-mode-advanced.md @@ -4,7 +4,7 @@ linkTitle: "Track mode" weight: 2 --- -Basic operations in the mode were described in section [track mode (basics)](/docs/for-users/user-guide/basics/shape-mode-basic/). +Basic operations in the mode were described in section [track mode (basics)](/docs/for-users/user-guide/basics/track-mode-basics/). Shapes that were created in the track mode, have extra navigation buttons. diff --git a/site/content/en/docs/for-users/user-guide/models.md b/site/content/en/docs/for-users/user-guide/models.md index 39365a999..1c3c0d463 100644 --- a/site/content/en/docs/for-users/user-guide/models.md +++ b/site/content/en/docs/for-users/user-guide/models.md @@ -4,8 +4,6 @@ linkTitle: "Models" weight: 5 --- -### Models - The Models page contains a list of deep learning (DL) models deployed for semi-automatic and automatic annotation. To open the Models page, click the Models button on the navigation bar. The list of models is presented in the form of a table. The parameters indicated for each model are the following: diff --git a/site/content/en/docs/for-users/user-guide/search.md b/site/content/en/docs/for-users/user-guide/search.md index 17e8e8d06..d2120c10a 100644 --- a/site/content/en/docs/for-users/user-guide/search.md +++ b/site/content/en/docs/for-users/user-guide/search.md @@ -3,7 +3,6 @@ title: "Search" linkTitle: "Search" weight: 6 --- -### Search There are several options how to use the search. diff --git a/site/layouts/partials/navbar.html b/site/layouts/partials/navbar.html new file mode 100644 index 000000000..54fccf7bd --- /dev/null +++ b/site/layouts/partials/navbar.html @@ -0,0 +1,35 @@ +{{ $cover := .HasShortcode "blocks/cover" }} + -- GitLab