diff --git a/site/content/en/docs/manual/advanced/3d-object-annotation-advanced.md b/site/content/en/docs/manual/advanced/3d-object-annotation-advanced.md index 763b7e49..62c17ac6 100644 --- a/site/content/en/docs/manual/advanced/3d-object-annotation-advanced.md +++ b/site/content/en/docs/manual/advanced/3d-object-annotation-advanced.md @@ -2,6 +2,7 @@ title: '3D Object annotation (advanced)' linkTitle: '3D Object annotation' weight: 18 +description: 'Overview of advanced operations available when annotating 3D objects.' --- As well as 2D-task objects, 3D-task objects support the ability to change appearance, attributes, diff --git a/site/content/en/docs/manual/advanced/ai-tools.md b/site/content/en/docs/manual/advanced/ai-tools.md index 53f5f1f2..9fab56fa 100644 --- a/site/content/en/docs/manual/advanced/ai-tools.md +++ b/site/content/en/docs/manual/advanced/ai-tools.md @@ -2,6 +2,7 @@ title: 'AI Tools' linkTitle: 'AI Tools' weight: 15 +description: 'Overview of semi-automatic and automatic annotation tools available in CVAT.' --- The tool is designed for semi-automatic and automatic annotation using DL models. diff --git a/site/content/en/docs/manual/advanced/analytics.md b/site/content/en/docs/manual/advanced/analytics.md index 410ad9fd..40c7e1f7 100644 --- a/site/content/en/docs/manual/advanced/analytics.md +++ b/site/content/en/docs/manual/advanced/analytics.md @@ -1,7 +1,8 @@ --- -title: 'Analytics' -linkTitle: 'Analytics' +title: 'Analytics Monitoring' +linkTitle: 'Analytics Monitoring' weight: 28 +description: 'Using Analytics to monitor usage statistics.' --- If your CVAT instance was created with analytics support, you can press the `Analytics` button in the dashboard diff --git a/site/content/en/docs/manual/advanced/annotation-with-cuboids/_index.md b/site/content/en/docs/manual/advanced/annotation-with-cuboids/_index.md index 3070bb78..0c0c2169 100644 --- a/site/content/en/docs/manual/advanced/annotation-with-cuboids/_index.md +++ b/site/content/en/docs/manual/advanced/annotation-with-cuboids/_index.md @@ -2,6 +2,7 @@ title: 'Annotation with cuboids' linkTitle: 'Annotation with cuboids' weight: 17 +description: 'Guide to creating and editing cuboids.' --- It is used to annotate 3 dimensional objects such as cars, boxes, etc... diff --git a/site/content/en/docs/manual/advanced/annotation-with-points/_index.md b/site/content/en/docs/manual/advanced/annotation-with-points/_index.md index 6a5f13e0..93a29fa2 100644 --- a/site/content/en/docs/manual/advanced/annotation-with-points/_index.md +++ b/site/content/en/docs/manual/advanced/annotation-with-points/_index.md @@ -2,4 +2,5 @@ title: 'Annotation with points' linkTitle: 'Annotation with points' weight: 11 +description: 'Guide to annotating tasks using single points or shapes containing multiple points.' --- diff --git a/site/content/en/docs/manual/advanced/annotation-with-polygons/_index.md b/site/content/en/docs/manual/advanced/annotation-with-polygons/_index.md index 659eb77b..dcf9fd85 100644 --- a/site/content/en/docs/manual/advanced/annotation-with-polygons/_index.md +++ b/site/content/en/docs/manual/advanced/annotation-with-polygons/_index.md @@ -2,4 +2,5 @@ title: 'Annotation with polygons' linkTitle: 'Annotation with polygons' weight: 13 +description: 'Guide to creating and editing polygons.' --- diff --git a/site/content/en/docs/manual/advanced/annotation-with-polylines.md b/site/content/en/docs/manual/advanced/annotation-with-polylines.md index 35a2fbe1..5fb7735c 100644 --- a/site/content/en/docs/manual/advanced/annotation-with-polylines.md +++ b/site/content/en/docs/manual/advanced/annotation-with-polylines.md @@ -2,6 +2,7 @@ title: 'Annotation with polylines' linkTitle: 'Annotation with polylines' weight: 12 +description: 'Guide to annotating tasks using polylines.' --- It is used for road markup annotation etc. diff --git a/site/content/en/docs/manual/advanced/attribute-annotation-mode-advanced.md b/site/content/en/docs/manual/advanced/attribute-annotation-mode-advanced.md index f294003c..2100451c 100644 --- a/site/content/en/docs/manual/advanced/attribute-annotation-mode-advanced.md +++ b/site/content/en/docs/manual/advanced/attribute-annotation-mode-advanced.md @@ -2,6 +2,7 @@ title: 'Attribute annotation mode (advanced)' linkTitle: 'Attribute annotation mode' weight: 6 +description: 'Advanced operations available in attribute annotation mode.' --- Basic operations in the mode were described in section [attribute annotation mode (basics)](/docs/manual/basics/attribute-annotation-mode-basics/). diff --git a/site/content/en/docs/manual/advanced/automatic-annotation.md b/site/content/en/docs/manual/advanced/automatic-annotation.md index e9702b5d..c40bc488 100644 --- a/site/content/en/docs/manual/advanced/automatic-annotation.md +++ b/site/content/en/docs/manual/advanced/automatic-annotation.md @@ -2,6 +2,7 @@ title: 'Automatic annotation' linkTitle: 'Automatic annotation' weight: 27 +description: 'Guide to using the automatic annotation of tasks.' --- Automatic Annotation is used for creating preliminary annotations. diff --git a/site/content/en/docs/manual/advanced/cli.md b/site/content/en/docs/manual/advanced/cli.md index 1b2f5f3b..8d487b63 100644 --- a/site/content/en/docs/manual/advanced/cli.md +++ b/site/content/en/docs/manual/advanced/cli.md @@ -2,7 +2,7 @@ title: 'Command line interface (CLI)' linkTitle: 'CLI' weight: 32 -description: This section on [GitHub](https://github.com/openvinotoolkit/cvat/tree/develop/utils/cli) +description: 'Guide to working with CVAT tasks in the command line interface. This section on [GitHub](https://github.com/openvinotoolkit/cvat/tree/develop/utils/cli).' --- **Description** diff --git a/site/content/en/docs/manual/advanced/context-images.md b/site/content/en/docs/manual/advanced/context-images.md index 933ddddf..765e94ec 100644 --- a/site/content/en/docs/manual/advanced/context-images.md +++ b/site/content/en/docs/manual/advanced/context-images.md @@ -2,9 +2,10 @@ title: 'Context images for 2d task' linkTitle: 'Context images' weight: 23 +description: 'Adding additional contextual images to a task.' --- -When you create a task, you can provide the images with additional contextual images. +When you create a task, you can provide the images with additional contextual images. To do this, create a folder related_images and place a folder with a contextual image in it (make sure the folder has the same name as the image to which it should be tied). An example of the structure: diff --git a/site/content/en/docs/manual/advanced/filter.md b/site/content/en/docs/manual/advanced/filter.md index c1a235e7..6904c11e 100644 --- a/site/content/en/docs/manual/advanced/filter.md +++ b/site/content/en/docs/manual/advanced/filter.md @@ -2,6 +2,7 @@ title: 'Filter' linkTitle: 'Filter' weight: 20 +description: 'Guide to using the Filter feature in CVAT.' --- There are some reasons to use the feature: diff --git a/site/content/en/docs/manual/advanced/formats/_index.md b/site/content/en/docs/manual/advanced/formats/_index.md index 332a711d..89c71a97 100644 --- a/site/content/en/docs/manual/advanced/formats/_index.md +++ b/site/content/en/docs/manual/advanced/formats/_index.md @@ -2,6 +2,7 @@ title: 'Formats' linkTitle: 'Formats' weight: 31 +description: 'List of annotation formats supported by CVAT.' --- #### CVAT supported the following formats: diff --git a/site/content/en/docs/manual/advanced/opencv-tools.md b/site/content/en/docs/manual/advanced/opencv-tools.md index 76cc96e3..c2808472 100644 --- a/site/content/en/docs/manual/advanced/opencv-tools.md +++ b/site/content/en/docs/manual/advanced/opencv-tools.md @@ -2,6 +2,7 @@ title: 'OpenCV tools' linkTitle: 'OpenCV tools' weight: 14 +description: 'Guide to using Computer Vision algorithms during annotation.' --- The tool based on [Open CV](https://opencv.org/) Computer Vision library diff --git a/site/content/en/docs/manual/advanced/projects.md b/site/content/en/docs/manual/advanced/projects.md index 55e80cc2..53e4003f 100644 --- a/site/content/en/docs/manual/advanced/projects.md +++ b/site/content/en/docs/manual/advanced/projects.md @@ -2,6 +2,7 @@ title: 'Projects' linkTitle: 'Projects' weight: 3 +description: 'Creating projects in CVAT.' --- At CVAT, you can create a project containing tasks of the same type. diff --git a/site/content/en/docs/manual/advanced/review.md b/site/content/en/docs/manual/advanced/review.md index ce55733c..d9eadd1e 100644 --- a/site/content/en/docs/manual/advanced/review.md +++ b/site/content/en/docs/manual/advanced/review.md @@ -2,6 +2,7 @@ title: 'Review' linkTitle: 'Review' weight: 22 +description: 'Guide to using the Review mode for task validation.' --- A special mode to check the annotation allows you to point to an object or area in the frame containing an error. diff --git a/site/content/en/docs/manual/advanced/search.md b/site/content/en/docs/manual/advanced/search.md index 0fb2f1a4..f4f2c898 100644 --- a/site/content/en/docs/manual/advanced/search.md +++ b/site/content/en/docs/manual/advanced/search.md @@ -2,6 +2,7 @@ title: 'Search' linkTitle: 'Search' weight: 2 +description: 'Overview of available search options.' --- There are several options how to use the search. diff --git a/site/content/en/docs/manual/advanced/shape-grouping.md b/site/content/en/docs/manual/advanced/shape-grouping.md index 9a570760..5de6fb6b 100644 --- a/site/content/en/docs/manual/advanced/shape-grouping.md +++ b/site/content/en/docs/manual/advanced/shape-grouping.md @@ -2,6 +2,7 @@ title: 'Shape grouping' linkTitle: 'Shape grouping' weight: 21 +description: 'Grouping multiple shapes during annotation.' --- This feature allows us to group several shapes. diff --git a/site/content/en/docs/manual/advanced/shape-mode-advanced.md b/site/content/en/docs/manual/advanced/shape-mode-advanced.md index d98cefd1..05cb14b9 100644 --- a/site/content/en/docs/manual/advanced/shape-mode-advanced.md +++ b/site/content/en/docs/manual/advanced/shape-mode-advanced.md @@ -2,6 +2,7 @@ title: 'Shape mode (advanced)' linkTitle: 'Shape mode' weight: 4 +description: 'Advanced operations available during annotation in shape mode.' --- Basic operations in the mode were described in section [shape mode (basics)](/docs/manual/basics/shape-mode-basics/). diff --git a/site/content/en/docs/manual/advanced/shortcuts.md b/site/content/en/docs/manual/advanced/shortcuts.md index 1f73bf12..3470c224 100644 --- a/site/content/en/docs/manual/advanced/shortcuts.md +++ b/site/content/en/docs/manual/advanced/shortcuts.md @@ -2,6 +2,7 @@ title: 'Shortcuts' linkTitle: 'Shortcuts' weight: 24 +description: 'List of available mouse and keyboard shortcuts.' --- Many UI elements have shortcut hints. Put your pointer to a required element to see it. diff --git a/site/content/en/docs/manual/advanced/track-mode-advanced.md b/site/content/en/docs/manual/advanced/track-mode-advanced.md index dacc0772..ec603712 100644 --- a/site/content/en/docs/manual/advanced/track-mode-advanced.md +++ b/site/content/en/docs/manual/advanced/track-mode-advanced.md @@ -2,6 +2,7 @@ title: 'Track mode (advanced)' linkTitle: 'Track mode' weight: 5 +description: 'Advanced operations available during annotation in track mode.' --- Basic operations in the mode were described in section [track mode (basics)](/docs/manual/basics/track-mode-basics/). diff --git a/site/content/en/docs/manual/basics/3d-object-annotation-basics.md b/site/content/en/docs/manual/basics/3d-object-annotation-basics.md index 132a8374..004248ae 100644 --- a/site/content/en/docs/manual/basics/3d-object-annotation-basics.md +++ b/site/content/en/docs/manual/basics/3d-object-annotation-basics.md @@ -2,6 +2,7 @@ title: '3D Object annotation (basics)' linkTitle: '3D Object annotation' weight: 13 +description: 'Overview of basic operations available when annotating 3D objects.' --- ### Navigation diff --git a/site/content/en/docs/manual/basics/attribute-annotation-mode-basics.md b/site/content/en/docs/manual/basics/attribute-annotation-mode-basics.md index 648d3ee4..18c46f0e 100644 --- a/site/content/en/docs/manual/basics/attribute-annotation-mode-basics.md +++ b/site/content/en/docs/manual/basics/attribute-annotation-mode-basics.md @@ -2,6 +2,7 @@ title: 'Attribute annotation mode (basics)' linkTitle: 'Attribute annotation mode' weight: 12 +description: 'Usage examples and basic operations available in attribute annotation mode.' --- - In this mode you can edit attributes with fast navigation between objects and frames using a keyboard. Open the drop-down list in the top panel and select Attribute annotation Mode. diff --git a/site/content/en/docs/manual/basics/basic-navigation.md b/site/content/en/docs/manual/basics/basic-navigation.md index 9f2a0373..2e8d476b 100644 --- a/site/content/en/docs/manual/basics/basic-navigation.md +++ b/site/content/en/docs/manual/basics/basic-navigation.md @@ -2,6 +2,7 @@ title: 'Basic navigation' linkTitle: 'Basic navigation' weight: 6 +description: 'Overview of basic controls.' --- 1. Use arrows below to move to the next/previous frame. Use the scroll bar slider to scroll through frames. diff --git a/site/content/en/docs/manual/basics/controls-sidebar.md b/site/content/en/docs/manual/basics/controls-sidebar.md index feaff597..0f84e20f 100644 --- a/site/content/en/docs/manual/basics/controls-sidebar.md +++ b/site/content/en/docs/manual/basics/controls-sidebar.md @@ -2,6 +2,7 @@ title: 'Controls sidebar' linkTitle: 'Controls sidebar' weight: 23 +description: 'Overview of available functions on the controls sidebar of the annotation tool.' --- ## Navigation diff --git a/site/content/en/docs/manual/basics/creating_an_annotation_task.md b/site/content/en/docs/manual/basics/creating_an_annotation_task.md index 3a66446d..37bcd439 100644 --- a/site/content/en/docs/manual/basics/creating_an_annotation_task.md +++ b/site/content/en/docs/manual/basics/creating_an_annotation_task.md @@ -2,6 +2,7 @@ title: 'Creating an annotation task' linkTitle: 'Creating an annotation task' weight: 2 +description: 'Instructions on how to create and configure an annotation task.' --- 1. Create an annotation task pressing `Create new task` button on the tasks page or on the project page. diff --git a/site/content/en/docs/manual/basics/objects-sidebar.md b/site/content/en/docs/manual/basics/objects-sidebar.md index 2d8fcbe9..5ee90f27 100644 --- a/site/content/en/docs/manual/basics/objects-sidebar.md +++ b/site/content/en/docs/manual/basics/objects-sidebar.md @@ -2,6 +2,7 @@ title: 'Objects sidebar' linkTitle: 'Objects sidebar' weight: 24 +description: 'Overview of available functions on the objects sidebar of the annotation tool.' --- ## Hide objects sidebar diff --git a/site/content/en/docs/manual/basics/shape-mode-basics.md b/site/content/en/docs/manual/basics/shape-mode-basics.md index f52acded..ba447113 100644 --- a/site/content/en/docs/manual/basics/shape-mode-basics.md +++ b/site/content/en/docs/manual/basics/shape-mode-basics.md @@ -2,6 +2,7 @@ title: 'Shape mode (basics)' linkTitle: 'Shape mode' weight: 10 +description: 'Usage examples and basic operations available during annotation in shape mode.' --- Usage examples: diff --git a/site/content/en/docs/manual/basics/task-details.md b/site/content/en/docs/manual/basics/task-details.md index 2d3db9b1..527c9df1 100644 --- a/site/content/en/docs/manual/basics/task-details.md +++ b/site/content/en/docs/manual/basics/task-details.md @@ -2,6 +2,7 @@ title: 'Task details' linkTitle: 'Task details' weight: 3 +description: 'Overview of the Task details page.' --- Task details is a task page which contains a preview, a progress bar diff --git a/site/content/en/docs/manual/basics/top-panel.md b/site/content/en/docs/manual/basics/top-panel.md index f894a73d..711a823d 100644 --- a/site/content/en/docs/manual/basics/top-panel.md +++ b/site/content/en/docs/manual/basics/top-panel.md @@ -2,6 +2,7 @@ title: 'Top Panel' linkTitle: 'Top Panel' weight: 21 +description: 'Overview of controls available on the top panel of the annotation tool.' --- ![](/images/image035.jpg) diff --git a/site/content/en/docs/manual/basics/track-mode-basics.md b/site/content/en/docs/manual/basics/track-mode-basics.md index 1a1c8780..7cb1a392 100644 --- a/site/content/en/docs/manual/basics/track-mode-basics.md +++ b/site/content/en/docs/manual/basics/track-mode-basics.md @@ -2,6 +2,7 @@ title: 'Track mode (basics)' linkTitle: 'Track mode' weight: 11 +description: 'Usage examples and basic operations available during annotation in track mode.' --- Usage examples: diff --git a/site/content/en/docs/manual/basics/types-of-shapes.md b/site/content/en/docs/manual/basics/types-of-shapes.md index 67d2a461..2f3c077a 100644 --- a/site/content/en/docs/manual/basics/types-of-shapes.md +++ b/site/content/en/docs/manual/basics/types-of-shapes.md @@ -2,6 +2,7 @@ title: 'Types of shapes' linkTitle: 'Types of shapes' weight: 5 +description: 'List of shapes available for annotation.' --- There are five shapes which you can annotate your images with: diff --git a/site/content/en/docs/manual/basics/vocabulary.md b/site/content/en/docs/manual/basics/vocabulary.md index 5a9228dc..2e9a390b 100644 --- a/site/content/en/docs/manual/basics/vocabulary.md +++ b/site/content/en/docs/manual/basics/vocabulary.md @@ -2,6 +2,7 @@ title: 'Vocabulary' linkTitle: 'Vocabulary' weight: 14 +description: 'List of terms pertaining to annotation in CVAT.' --- **Label** is a type of an annotated object (e.g. person, car, vehicle, etc.) diff --git a/site/content/en/docs/manual/basics/workspace.md b/site/content/en/docs/manual/basics/workspace.md index e331e630..de7090ca 100644 --- a/site/content/en/docs/manual/basics/workspace.md +++ b/site/content/en/docs/manual/basics/workspace.md @@ -2,6 +2,7 @@ title: 'Workspace' linkTitle: 'Workspace' weight: 22 +description: 'Overview of available functions on the workspace of the annotation tool.' --- This is the main field in which drawing and editing objects takes place.