Fix embed build

[github/Chocobozzz/PeerTube.git] / .github / CONTRIBUTING.md

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index f0a4043accd8e4247434156b53ecb0d1e4a4140e..704b22b8b52b86048253b030bd6c0e4118a48fc3 100644 (file)
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -4,13 +4,26 @@ Interested in contributing? Awesome!
 
 **This guide will present you the following contribution topics:**
 
 
 **This guide will present you the following contribution topics:**
 

-  * [Translate](#translate)
-  * [Give your feedback](#give-your-feedback)
-  * [Write documentation](#write-documentation)
-  * [Develop](#develop)
-  * [Improve the website](#improve-the-website)
-  * [Troubleshooting](#troubleshooting)
-  * [Tutorials](#tutorials)
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+
+- [Translate](#translate)
+- [Give your feedback](#give-your-feedback)
+- [Write documentation](#write-documentation)
+- [Improve the website](#improve-the-website)
+- [Develop](#develop)
+  - [Prerequisites](#prerequisites)
+  - [Online development](#online-development)
+  - [Server side](#server-side)
+  - [Client side](#client-side)
+  - [Client and server side](#client-and-server-side)
+  - [Testing the federation of PeerTube servers](#testing-the-federation-of-peertube-servers)
+  - [Unit tests](#unit-tests)
+  - [Emails](#emails)
+- [Plugins & Themes](#plugins--themes)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->

 
 ## Translate
 
 
 ## Translate
 


@@ -30,13 +43,13 @@ interested in, user interface, design, decentralized architecture...
 You can help to write the documentation of the REST API, code, architecture,
 demonstrations.
 
 You can help to write the documentation of the REST API, code, architecture,
 demonstrations.
 

-For the REST API you can see the documentation in [/support/doc/api](/support/doc/api) directory.
-Then, you can just open the `openapi.yaml` file in a special editor like [http://editor.swagger.io/](http://editor.swagger.io/) to easily see and edit the documentation.
+For the REST API you can see the documentation in [/support/doc/api](https://github.com/Chocobozzz/PeerTube/tree/develop/support/doc/api) directory.
+Then, you can just open the `openapi.yaml` file in a special editor like [http://editor.swagger.io/](http://editor.swagger.io/) to easily see and edit the documentation. You can also use [redoc-cli](https://github.com/Redocly/redoc/blob/master/cli/README.md) and run `redoc-cli serve --watch support/doc/api/openapi.yaml` to see the final result.

 
 Some hints:
 
 Some hints:

- * Routes are defined in [/server/controllers/](/server/controllers/) directory
- * Parameters validators are defined in [/server/middlewares/validators](/server/middlewares/validators) directory
- * Models sent/received by the controllers are defined in [/shared/models](/shared/models) directory
+ * Routes are defined in [/server/controllers/](https://github.com/Chocobozzz/PeerTube/tree/develop/server/controllers) directory
+ * Parameters validators are defined in [/server/middlewares/validators](https://github.com/Chocobozzz/PeerTube/tree/develop/server/middlewares/validators) directory
+ * Models sent/received by the controllers are defined in [/shared/models](https://github.com/Chocobozzz/PeerTube/tree/develop/shared/models) directory

 
 
 ## Improve the website
 
 
 ## Improve the website


@@ -57,14 +70,16 @@ before you start working on them :).
 
 First, you should use a server or PC with at least 4GB of RAM. Less RAM may lead to crashes.
 
 
 First, you should use a server or PC with at least 4GB of RAM. Less RAM may lead to crashes.
 

-Make sure that you have followed 
-[the steps](/support/doc/dependencies.md) 
+Make sure that you have followed
+[the steps](/support/doc/dependencies.md)

 to install the dependencies.
 
 to install the dependencies.
 

-Then clone the sources and install node modules:
+Fork the github repository,
+and then clone the sources and install node modules:

 
 ```
 $ git clone https://github.com/Chocobozzz/PeerTube
 
 ```
 $ git clone https://github.com/Chocobozzz/PeerTube

+$ git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git

 $ cd PeerTube
 $ yarn install --pure-lockfile
 ```
 $ cd PeerTube
 $ yarn install --pure-lockfile
 ```


@@ -73,6 +88,12 @@ Note that development is done on the `develop` branch. If you want to hack on
 Peertube, you should switch to that branch. Also note that you have to repeat
 the `yarn install --pure-lockfile` command.
 
 Peertube, you should switch to that branch. Also note that you have to repeat
 the `yarn install --pure-lockfile` command.
 

+When you create a new branch you should also tell to use your repo for upload
+not default one. To do just do:
+```
+$ git push --set-upstream me <your branch name>
+```
+

 Then, create a postgres database and user with the values set in the
 `config/default.yaml` file. For instance, if you do not change the values
 there, the following commands would create a new database called `peertube_dev`
 Then, create a postgres database and user with the values set in the
 `config/default.yaml` file. For instance, if you do not change the values
 there, the following commands would create a new database called `peertube_dev`


@@ -93,9 +114,15 @@ $ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev
 
 In dev mode, administrator username is **root** and password is **test**.
 
 
 In dev mode, administrator username is **root** and password is **test**.
 

+### Online development
+
+You can get a complete PeerTube development setup with Gitpod, a free one-click online IDE for GitHub:
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Chocobozzz/PeerTube)
+

 ### Server side
 
 ### Server side
 

-You can find a documentation of the server code/architecture [here](/support/doc/development/server/code.md).
+You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/#/contribute-architecture?id=server-code).

 
 To develop on the server-side:
 
 
 To develop on the server-side:
 


@@ -109,8 +136,8 @@ restart.
 
 ### Client side
 
 
 ### Client side
 

-You can find a documentation of the server code/architecture
-[here](/support/doc/development/client/code.md).
+You can find a documentation of the client code/architecture
+[here](https://docs.joinpeertube.org/#/contribute-architecture?id=client-code).

 
 
 To develop on the client side:
 
 
 To develop on the client side:


@@ -169,29 +196,32 @@ Then, we can create the databases (if they don't already exist):
 
 ```
 $ sudo -u postgres createuser you_username --createdb --superuser
 
 ```
 $ sudo -u postgres createuser you_username --createdb --superuser

-$ createdb -O peertube peertube_test{1,2,3,4,5,6}
+$ npm run clean:server:test

 ```
 
 Build the application and run the unit/integration tests:
 
 ```
 ```
 
 Build the application and run the unit/integration tests:
 
 ```

-$ npm run build
+$ npm run build -- --light

 $ npm test
 ```
 
 If you just want to run 1 test:
 
 ```
 $ npm test
 ```
 
 If you just want to run 1 test:
 
 ```

-$ npm run mocha -- --exit --require ts-node/register/type-check --bail server/tests/api/index.ts
+$ npm run mocha -- --exit -r ts-node/register -r tsconfig-paths/register --bail server/tests/api/index.ts

 ```
 
 Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
 Note that only instance 2 has transcoding enabled.
 
 ```
 
 Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
 Note that only instance 2 has transcoding enabled.
 

-### Troubleshooting
+### Emails
+
+To test emails with PeerTube:

 
 

-Please check out the issues and [list of common errors](https://docs.joinpeertube.org/lang/en/devdocs/troubleshooting.html).
+ * Run [mailslurper](http://mailslurper.com/)
+ * Run PeerTube using mailslurper SMTP port: `NODE_CONFIG='{ "smtp": { "hostname": "localhost", "port": 2500, "tls": false } }' NODE_ENV=test npm start`

 
 

-### Tutorials
+## Plugins & Themes

 
 

-Please check out the related section in the [development documentation](https://docs.joinpeertube.org/lang/en/devdocs/index.html#tutorials). Contribute tutorials at [framagit.org/framasoft/peertube/documentation](https://framagit.org/framasoft/peertube/documentation).
+See the dedicated documentation: https://docs.joinpeertube.org/#/contribute-plugins