wangchunlin
/
cvat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Publication CONTRIBUTING.md on the website (#3271)

Browse Source 
* publication contributing.md on website

* fix link and markup in CONTRIBUTING.md

* fix link
main
Timur Osmanov 5 years ago committed by GitHub
parent f662126044
commit 72f6776b9c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File

1
README.md
Unescape Escape View File

@ -17,6 +17,7 @@ annotation team. Try it online [cvat.org](https://cvat.org).
## Documentation ## Documentation
- [Contributing](https://openvinotoolkit.github.io/cvat/docs/for-developers/contributing/)
- [Installation guide](https://openvinotoolkit.github.io/cvat/docs/for-users/installation/) - [Installation guide](https://openvinotoolkit.github.io/cvat/docs/for-users/installation/)
- [User's guide](https://openvinotoolkit.github.io/cvat/docs/for-users/user-guide/) - [User's guide](https://openvinotoolkit.github.io/cvat/docs/for-users/user-guide/)
- [Django REST API documentation](#rest-api) - [Django REST API documentation](#rest-api)

13
CONTRIBUTING.md → site/content/en/docs/for-developers/CONTRIBUTING.md
Unescape Escape View File

@ -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 Please take a moment to review this document in order to make the contribution
process easy and effective for everyone involved. process easy and effective for everyone involved.
@ -38,7 +42,7 @@ patches and features.
- Install CVAT on your local host: - Install CVAT on your local host:
```sh ```sh
git clone https://github.com/opencv/cvat git clone https://github.com/openvinotoolkit/cvat
cd cvat && mkdir logs keys cd cvat && mkdir logs keys
python3 -m venv .env python3 -m venv .env
. .env/bin/activate . .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. 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. - 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 ### 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 - You have to install `nuctl` command line tool to build and deploy serverless
functions. functions.
@ -253,6 +257,7 @@ Server = nuclio
``` ```
</details> </details>
### Run Cypress tests ### Run Cypress tests
- Install Сypress as described in the [documentation](https://docs.cypress.io/guides/getting-started/installing-cypress.html). - Install Сypress as described in the [documentation](https://docs.cypress.io/guides/getting-started/installing-cypress.html).
- Run cypress tests: - Run cypress tests:
Write Preview
Loading…
Cancel
Save