diff options
-rw-r--r-- | .github/CONTRIBUTING.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 86b4ae704..2f1774756 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md | |||
@@ -22,6 +22,8 @@ Interested in contributing? Awesome! | |||
22 | - [Unit/integration tests](#unitintegration-tests) | 22 | - [Unit/integration tests](#unitintegration-tests) |
23 | - [Testing the federation of PeerTube servers](#testing-the-federation-of-peertube-servers) | 23 | - [Testing the federation of PeerTube servers](#testing-the-federation-of-peertube-servers) |
24 | - [Emails](#emails) | 24 | - [Emails](#emails) |
25 | - [OpenAPI documentation](#openapi-documentation) | ||
26 | - [Environment variables](#environment-variables) | ||
25 | - [Plugins & Themes](#plugins--themes) | 27 | - [Plugins & Themes](#plugins--themes) |
26 | 28 | ||
27 | <!-- END doctoc generated TOC please keep comment here to allow auto update --> | 29 | <!-- END doctoc generated TOC please keep comment here to allow auto update --> |
@@ -221,6 +223,15 @@ To test emails with PeerTube: | |||
221 | * Run [mailslurper](http://mailslurper.com/) | 223 | * Run [mailslurper](http://mailslurper.com/) |
222 | * Run PeerTube using mailslurper SMTP port: `NODE_CONFIG='{ "smtp": { "hostname": "localhost", "port": 2500, "tls": false } }' NODE_ENV=dev node dist/server` | 224 | * Run PeerTube using mailslurper SMTP port: `NODE_CONFIG='{ "smtp": { "hostname": "localhost", "port": 2500, "tls": false } }' NODE_ENV=dev node dist/server` |
223 | 225 | ||
226 | ### OpenAPI documentation | ||
227 | |||
228 | The [REST API documentation](https://docs.joinpeertube.org/api-rest-reference.html) is generated from `support/doc/api/openapi.yaml` file. | ||
229 | To quickly get a preview of your changes, you can generate the documentation *on the fly* using the following command: | ||
230 | |||
231 | ``` | ||
232 | npx redoc-cli serve --watch ./support/doc/api/openapi.yaml | ||
233 | ``` | ||
234 | |||
224 | ### Environment variables | 235 | ### Environment variables |
225 | 236 | ||
226 | PeerTube can be configured using environment variables. | 237 | PeerTube can be configured using environment variables. |