diff options
author | Mats Blomdahl <mats.blomdahl@gmail.com> | 2023-04-05 08:51:38 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-04-05 08:51:38 +0200 |
commit | 907bcfa02c64ffa7f39b272155d36548e05350a7 (patch) | |
tree | 2001eb5bded46c662090dc4b0f1055d6caa69f26 /.github/CONTRIBUTING.md | |
parent | 00ee545c2444c35ed0d37df9f91984246aa36124 (diff) | |
download | PeerTube-907bcfa02c64ffa7f39b272155d36548e05350a7.tar.gz PeerTube-907bcfa02c64ffa7f39b272155d36548e05350a7.tar.zst PeerTube-907bcfa02c64ffa7f39b272155d36548e05350a7.zip |
Misc wording fixes, while learning how to test/contribute (#5727)
* Misc wording fixes, while learning how to test/contribute
- Remove duplicate discrimination topic in Code of Conduct
- Correct capitalization of some brands (PeerTube, GitHub)
- Replace `npm` with `yarn`, for additional consistency
* Revert `yarn` to `npm run` per PR #5727 comment
* Remove note on how to start Redis on Windows/WSL
Diffstat (limited to '.github/CONTRIBUTING.md')
-rw-r--r-- | .github/CONTRIBUTING.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c5e62e44d..7cc753b1a 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md | |||
@@ -88,7 +88,7 @@ First, you should use a server or PC with at least 4GB of RAM. Less RAM may lead | |||
88 | [the steps](/support/doc/dependencies.md) | 88 | [the steps](/support/doc/dependencies.md) |
89 | to install the dependencies. | 89 | to install the dependencies. |
90 | 1) Install [parallel](https://www.gnu.org/software/parallel/) to be able to run tests. | 90 | 1) Install [parallel](https://www.gnu.org/software/parallel/) to be able to run tests. |
91 | 1) Fork the Github repository. | 91 | 1) Fork the GitHub repository. |
92 | 1) Run the following commands. | 92 | 1) Run the following commands. |
93 | ``` | 93 | ``` |
94 | git clone https://github.com/Chocobozzz/PeerTube | 94 | git clone https://github.com/Chocobozzz/PeerTube |
@@ -98,7 +98,7 @@ yarn install --pure-lockfile | |||
98 | ``` | 98 | ``` |
99 | 99 | ||
100 | Note that development is done on the `develop` branch. If you want to hack on | 100 | Note that development is done on the `develop` branch. If you want to hack on |
101 | Peertube, you should switch to that branch. Also note that you have to repeat | 101 | PeerTube, you should switch to that branch. Also note that you have to repeat |
102 | the `yarn install --pure-lockfile` command. | 102 | the `yarn install --pure-lockfile` command. |
103 | 103 | ||
104 | When you create a new branch you should also tell to use your repo for upload | 104 | When you create a new branch you should also tell to use your repo for upload |
@@ -125,7 +125,7 @@ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_dev | |||
125 | sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev | 125 | sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev |
126 | ``` | 126 | ``` |
127 | 127 | ||
128 | Peertube also requires a running redis server, no special setup is needed for | 128 | PeerTube also requires a running redis server, no special setup is needed for |
129 | this. | 129 | this. |
130 | 130 | ||
131 | In dev mode, administrator username is **root** and password is **test**. | 131 | In dev mode, administrator username is **root** and password is **test**. |
@@ -278,7 +278,7 @@ You can see the list on the [dedicated documentation](/support/doc/development/l | |||
278 | 278 | ||
279 | ### CI | 279 | ### CI |
280 | 280 | ||
281 | PeerTube uses Github actions to run tests every time a commit is pushed or a PR is opened. | 281 | PeerTube uses GitHub actions to run tests every time a commit is pushed or a PR is opened. |
282 | You can find more information about these tasks on the [dedicated documentation](/support/doc/development/ci.md). | 282 | You can find more information about these tasks on the [dedicated documentation](/support/doc/development/ci.md). |
283 | 283 | ||
284 | ### Monitoring | 284 | ### Monitoring |
@@ -288,11 +288,11 @@ To do so, see the [dedicated documentation](/support/doc/development/monitoring. | |||
288 | 288 | ||
289 | ### Test live stream | 289 | ### Test live stream |
290 | 290 | ||
291 | To easily test a live on PeerTube: | 291 | To easily test a live stream on PeerTube: |
292 | * Enable live support in web admin configuration | 292 | * Enable live support in web admin configuration |
293 | * Create a permanent live on the PeerTube instance | 293 | * Create a permanent live on the PeerTube instance |
294 | * Get the **RTMP URL** and the **Live stream key** | 294 | * Get the **RTMP URL** and the **Live stream key** |
295 | * Send the live to PeerTube using `ffmpeg` using a local video: | 295 | * Send the live stream to PeerTube using `ffmpeg` using a local video: |
296 | 296 | ||
297 | ``` | 297 | ``` |
298 | ffmpeg -stream_loop -1 -re -i any-video.mp4 -c copy -f flv rtmp://{RTMP URL}/live/{STREAM KEY} | 298 | ffmpeg -stream_loop -1 -re -i any-video.mp4 -c copy -f flv rtmp://{RTMP URL}/live/{STREAM KEY} |