From 72f6776b9c45f1f318a4112869442b129901ba84 Mon Sep 17 00:00:00 2001 From: Timur Osmanov <54434686+TOsmanov@users.noreply.github.com> Date: Wed, 2 Jun 2021 19:59:30 +0300 Subject: [PATCH] Publication CONTRIBUTING.md on the website (#3271) * publication contributing.md on website * fix link and markup in CONTRIBUTING.md * fix link --- README.md | 1 + .../content/en/docs/for-developers/CONTRIBUTING.md | 13 +++++++++---- 2 files changed, 10 insertions(+), 4 deletions(-) rename CONTRIBUTING.md => site/content/en/docs/for-developers/CONTRIBUTING.md (98%) diff --git a/README.md b/README.md index 62836bc2..5eb8bd44 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,7 @@ annotation team. Try it online [cvat.org](https://cvat.org). ## Documentation +- [Contributing](https://openvinotoolkit.github.io/cvat/docs/for-developers/contributing/) - [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) diff --git a/CONTRIBUTING.md b/site/content/en/docs/for-developers/CONTRIBUTING.md similarity index 98% rename from CONTRIBUTING.md rename to site/content/en/docs/for-developers/CONTRIBUTING.md index 6686f747..4e42421b 100644 --- a/CONTRIBUTING.md +++ b/site/content/en/docs/for-developers/CONTRIBUTING.md @@ -1,4 +1,8 @@ -# Contributing to this project +--- +title: "Contributing to this project" +linkTitle: "Contributing" +weight: 1 +--- Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved. @@ -38,7 +42,7 @@ patches and features. - Install CVAT on your local host: ```sh - git clone https://github.com/opencv/cvat + git clone https://github.com/openvinotoolkit/cvat cd cvat && mkdir logs keys python3 -m venv .env . .env/bin/activate @@ -106,7 +110,7 @@ You have done! Now it is possible to insert breakpoints and debug server and cli You develop CVAT under WSL (Windows subsystem for Linux) following next steps. -- Install WSL using [this guide](https://docs.microsoft.com/ru-ru/windows/wsl/install-win10). +- Install WSL using [this guide](https://docs.microsoft.com/en-us/windows/wsl/install-win10). - Following this guide install Ubuntu 18.04 Linux distribution for WSL. @@ -122,7 +126,7 @@ You develop CVAT under WSL (Windows subsystem for Linux) following next steps. ### DL models as serverless functions -Follow this [guide](/cvat/apps/documentation/installation_automatic_annotation.md) to install Nuclio: +Follow this [guide](/docs/for-users/installation_automatic_annotation/) to install Nuclio: - You have to install `nuctl` command line tool to build and deploy serverless functions. @@ -253,6 +257,7 @@ Server = nuclio ``` + ### Run Cypress tests - Install Сypress as described in the [documentation](https://docs.cypress.io/guides/getting-started/installing-cypress.html). - Run cypress tests: