]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - .github/CONTRIBUTING.md
Translated using Weblate (Thai)
[github/Chocobozzz/PeerTube.git] / .github / CONTRIBUTING.md
index 59dbc685479e52eb57fad66626bdaf7cf3bcc0b0..56c3b65d16282259edb76c5a7e2720015e2406a9 100644 (file)
@@ -138,8 +138,6 @@ You can get a complete PeerTube development setup with Gitpod, a free one-click
 
 ### Server side
 
-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:
 
 ```
@@ -150,11 +148,11 @@ Then, the server will listen on `localhost:9000`. When server source files
 change, these are automatically recompiled and the server will automatically
 restart.
 
-### Client side
-
-You can find a documentation of the client code/architecture
-[here](https://docs.joinpeertube.org/contribute-architecture?id=client-code).
+More detailed documentation is available:
+  * [Server code/architecture](https://docs.joinpeertube.org/contribute/architecture#server)
+  * [Server development (adding a new feature...)](/support/doc/development/server.md)
 
+### Client side
 
 To develop on the client side:
 
@@ -166,6 +164,10 @@ The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
 Client files are automatically compiled on change, and the web browser will
 reload them automatically thanks to hot module replacement.
 
+More detailed documentation is available:
+  * [Client code/architecture](https://docs.joinpeertube.org/contribute/architecture#client)
+
+
 ### Client and server side
 
 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
@@ -228,7 +230,7 @@ $ NODE_APP_INSTANCE=2 NODE_ENV=test npm start
 $ NODE_APP_INSTANCE=3 NODE_ENV=test npm start
 ```
 
-Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
+Then you will get access to the three nodes at `http://127.0.0.1:900{1,2,3}`
 with the `root` as username and `test{1,2,3}` for the password.
 
 Instance configurations are in `config/test-{1,2,3}.yaml`.
@@ -242,17 +244,17 @@ To test emails with PeerTube:
 
 ### OpenAPI documentation
 
-The [REST API documentation](https://docs.joinpeertube.org/api-rest-reference.html) is generated from `support/doc/api/openapi.yaml` file.
+The [REST API documentation](https://docs.joinpeertube.org/api/rest-reference.html) is generated from `support/doc/api/openapi.yaml` file.
 To quickly get a preview of your changes, you can generate the documentation *on the fly* using the following command:
 
 ```
-npx redoc-cli serve --watch ./support/doc/api/openapi.yaml
+npx @redocly/cli preview-docs ./support/doc/api/openapi.yaml
 ```
 
 ### Environment variables
 
 PeerTube can be configured using environment variables.
-See the list on https://docs.joinpeertube.org/maintain-configuration?id=environment-variables
+See the list on https://docs.joinpeertube.org/maintain/configuration#environment-variables
 
 Additionally to these ones, we provide some environment for dev/test purpose:
 
@@ -298,4 +300,4 @@ ffmpeg -stream_loop -1 -re -i any-video.mp4 -c copy -f flv rtmp://{RTMP URL}/liv
 
 ## Plugins & Themes
 
-See the dedicated documentation: https://docs.joinpeertube.org/contribute-plugins
+See the dedicated documentation: https://docs.joinpeertube.org/contribute/plugins