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.
main
Artem Filippov 5 years ago committed by GitHub
parent 508ce7cdba
commit d773f8c6a5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -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
---

@ -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
---

@ -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).'
---

@ -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-->

@ -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.'
---

@ -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-->

@ -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.

@ -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.

@ -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
---

@ -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.'
---

@ -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
---

@ -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).

@ -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.

@ -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

@ -2,6 +2,7 @@
title: 'Development environment'
linkTitle: 'Development environment'
weight: 2
description: 'Installing a development environment for different operating systems.'
---
- Install necessary dependencies:

@ -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

@ -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`

@ -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

@ -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

@ -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

@ -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),

Loading…
Cancel
Save