Documentation update, adding descriptions for pages in Administration…

… and Contributing sections. (#3518) * Added descriptions for headers in Administration and Contributing sections. * Added periods to descriptions.
cvat-ai · Aug 6, 2021 · d773f8c · d773f8c
1 parent 508ce7c
commit d773f8c
Show file tree

Hide file tree

Showing 21 changed files with 23 additions and 11 deletions.
diff --git a/site/content/en/docs/administration/_index.md b/site/content/en/docs/administration/_index.md
@@ -3,7 +3,7 @@
 title: 'Administration'
 linkTitle: 'Administration'
 weight: 3
-description: 'This section contains documents for system administrators'
+description: 'This section contains documents for system administrators.'
 hide_feedback: true
 
 ---
diff --git a/site/content/en/docs/administration/advanced/_index.md b/site/content/en/docs/administration/advanced/_index.md
@@ -3,7 +3,7 @@
 title: 'Advanced'
 linkTitle: 'Advanced'
 weight: 2
-description: 'This section contains basic documents for system administrators'
+description: 'This section contains advanced documents for system administrators.'
 hide_feedback: true
 
 ---
diff --git a/site/content/en/docs/administration/advanced/analytics.md b/site/content/en/docs/administration/advanced/analytics.md
@@ -2,10 +2,10 @@
 
 ---
 
-title: 'Analytics for Computer Vision Annotation Tool (CVAT)'
-linkTitle: 'Analytics'
+title: 'Installation Analytics'
+linkTitle: 'Installation Analytics'
 weight: 2
-description: This section on [GitHub](https://github.com/openvinotoolkit/cvat/tree/develop/components/analytics)
+description: 'Instructions for deployment and customization of Analytics. This section on [GitHub](https://github.com/openvinotoolkit/cvat/tree/develop/components/analytics).'
 
 ---
 

diff --git a/site/content/en/docs/administration/advanced/backup_guide.md b/site/content/en/docs/administration/advanced/backup_guide.md
@@ -2,6 +2,7 @@
 title: 'Backup guide'
 linkTitle: 'Backup guide'
 weight: 11
+description: 'Instructions on how to backup CVAT data with Docker.'
 ---
 
 <!--lint disable heading-style-->

diff --git a/site/content/en/docs/administration/advanced/installation_automatic_annotation.md b/site/content/en/docs/administration/advanced/installation_automatic_annotation.md
@@ -5,8 +5,7 @@
 title: 'Semi-automatic and Automatic Annotation'
 linkTitle: 'Installation Auto Annotation'
 weight: 5
-description: 'This page provides information about the installation of components needed for
-semi-automatic and automatic annotation'
+description: 'Information about the installation of components needed for semi-automatic and automatic annotation.'
 
 ---
 

diff --git a/site/content/en/docs/administration/advanced/mounting_cloud_storages.md b/site/content/en/docs/administration/advanced/mounting_cloud_storages.md
@@ -2,6 +2,7 @@
 title: 'Mounting cloud storage'
 linkTitle: 'Mounting cloud storage'
 weight: 10
+description: 'Instructions on how to mount AWS S3 bucket, Microsoft Azure container or Google Drive as a filesystem.'
 ---
 
 <!--lint disable heading-style-->

diff --git a/site/content/en/docs/administration/basics/AWS-Deployment-Guide.md b/site/content/en/docs/administration/basics/AWS-Deployment-Guide.md
@@ -2,6 +2,7 @@
 title: 'AWS-Deployment Guide'
 linkTitle: 'AWS-Deployment Guide'
 weight: 4
+description: 'Instructions for deploying CVAT on Nvidia GPU and other AWS machines.'
 ---
 
 There are two ways of deploying the CVAT.

diff --git a/site/content/en/docs/administration/basics/REST_API_guide.md b/site/content/en/docs/administration/basics/REST_API_guide.md
@@ -2,6 +2,7 @@
 title: 'REST API guide'
 linkTitle: 'REST API'
 weight: 12
+description: 'Instructions on how to interact with REST API and getting swagger documentation.'
 ---
 
 To access swagger documentation you need to be authorized.

diff --git a/site/content/en/docs/administration/basics/_index.md b/site/content/en/docs/administration/basics/_index.md
@@ -3,7 +3,7 @@
 title: 'Basics'
 linkTitle: 'Basics'
 weight: 1
-description: 'This section contains basic documents for system administrators'
+description: 'This section contains basic documents for system administrators.'
 hide_feedback: true
 
 ---
diff --git a/site/content/en/docs/administration/basics/installation.md b/site/content/en/docs/administration/basics/installation.md
@@ -5,7 +5,7 @@
 title: 'Installation Guide'
 linkTitle: 'Installation Guide'
 weight: 1
-description: 'CVAT installation guide for different operating systems'
+description: 'A CVAT installation guide for different operating systems.'
 
 ---
 

diff --git a/site/content/en/docs/contributing/_index.md b/site/content/en/docs/contributing/_index.md
@@ -2,7 +2,7 @@
 title: 'Contributing to this project'
 linkTitle: 'Contributing'
 weight: 4
-description: 'This section contains documents for CVAT developers'
+description: 'This section contains documents for CVAT developers.'
 hide_feedback: true
 ul_show: false
 ---

diff --git a/site/content/en/docs/contributing/branching-model.md b/site/content/en/docs/contributing/branching-model.md
@@ -2,6 +2,7 @@
 title: 'Branching model'
 linkTitle: 'Branching model'
 weight: 5
+description: 'Information about the branching model that is used in the project.'
 ---
 
 The project uses [a successful Git branching model](https://nvie.com/posts/a-successful-git-branching-model).

diff --git a/site/content/en/docs/contributing/bug-reports.md b/site/content/en/docs/contributing/bug-reports.md
@@ -2,6 +2,7 @@
 title: 'Bug reports'
 linkTitle: 'Bug reports'
 weight: 7
+description: 'Guidelines and an example of how to report a bug.'
 ---
 
 A bug is a _demonstrable problem_ that is caused by the code in the repository.

diff --git a/site/content/en/docs/contributing/coding-style.md b/site/content/en/docs/contributing/coding-style.md
@@ -2,6 +2,7 @@
 title: 'JavaScript/Typescript coding style'
 linkTitle: 'JavaScript/Typescript coding style'
 weight: 4
+description: 'Information about JavaScript/Typescript coding style that is used in CVAT development.'
 ---
 
 We use the [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript) for JavaScript code with a

diff --git a/site/content/en/docs/contributing/development-environment.md b/site/content/en/docs/contributing/development-environment.md
@@ -2,6 +2,7 @@
 title: 'Development environment'
 linkTitle: 'Development environment'
 weight: 2
+description: 'Installing a development environment for different operating systems.'
 ---
 
 - Install necessary dependencies:

diff --git a/site/content/en/docs/contributing/feature-requests.md b/site/content/en/docs/contributing/feature-requests.md
@@ -2,6 +2,7 @@
 title: 'Feature requests'
 linkTitle: 'Feature requests'
 weight: 8
+description: 'Information on requesting new features.'
 ---
 
 Feature requests are welcome. But take a moment to find out whether your idea

diff --git a/site/content/en/docs/contributing/new-annotation-format.md b/site/content/en/docs/contributing/new-annotation-format.md
@@ -2,7 +2,7 @@
 title: 'How to add a new annotation format support'
 linkTitle: 'New annotation format support'
 weight: 10
-description: This section on [GitHub](https://github.com/openvinotoolkit/cvat/tree/develop/cvat/apps/dataset_manager/formats)
+description: 'Instructions on adding support for new annotation formats. This section on [GitHub](https://github.com/openvinotoolkit/cvat/tree/develop/cvat/apps/dataset_manager/formats).'
 ---
 
 1. Add a python script to `dataset_manager/formats`

diff --git a/site/content/en/docs/contributing/pull-requests.md b/site/content/en/docs/contributing/pull-requests.md
@@ -2,6 +2,7 @@
 title: 'Pull requests'
 linkTitle: 'Pull requests'
 weight: 9
+description: 'Instructions on how to create a pull request.'
 ---
 
 Good pull requests - patches, improvements, new features - are a fantastic

diff --git a/site/content/en/docs/contributing/rest-api-design.md b/site/content/en/docs/contributing/rest-api-design.md
@@ -2,6 +2,7 @@
 title: 'REST API design principles'
 linkTitle: 'REST API design principles'
 weight: 100
+description: 'Information on using the REST API scheme and principles of its design.'
 ---
 
 ## REST API scheme

diff --git a/site/content/en/docs/contributing/setup-additional-components.md b/site/content/en/docs/contributing/setup-additional-components.md
@@ -2,6 +2,7 @@
 title: 'Setup additional components in development environment'
 linkTitle: 'Setup additional components in development environment'
 weight: 3
+description: 'Deploying a DL model as a serverless function and Cypress tests.'
 ---
 
 ## DL models as serverless functions

diff --git a/site/content/en/docs/contributing/using-the-issue-tracker.md b/site/content/en/docs/contributing/using-the-issue-tracker.md
@@ -2,6 +2,7 @@
 title: 'Using the issue tracker'
 linkTitle: 'Using the issue tracker'
 weight: 6
+description: 'Information and rules for using the issue tracker.'
 ---
 
 The issue tracker is the preferred channel for [bug reports](#bugs),