Documentation update, adding descriptions to pages located in Basics …

…and Advanced sections of Manual (#3522) * Added descriptions to sections manual/basics and manual/advanced * fixed wording + additional description
cvat-ai · Aug 6, 2021 · 508ce7c · 508ce7c
1 parent e1198c3
commit 508ce7c
Show file tree

Hide file tree

Showing 34 changed files with 37 additions and 4 deletions.
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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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.