IntenseWebs/PeerTube
3
0
Fork 0
mirror of https://github.com/Chocobozzz/PeerTube.git synced 2024-11-22 00:38:03 -06:00
Code Issues Packages Projects Releases Wiki Activity

Misc wording fixes, while learning how to test/contribute (#5727)

Browse Source 
* 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
This commit is contained in:
Mats Blomdahl 2023-04-05 08:51:38 +02:00 committed by GitHub
parent 00ee545c24
commit 907bcfa02c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
.github/CONTRIBUTING.md vendored
View File

@ -88,7 +88,7 @@ First, you should use a server or PC with at least 4GB of RAM. Less RAM may lead
[the steps](/support/doc/dependencies.md) [the steps](/support/doc/dependencies.md)
to install the dependencies. to install the dependencies.
1) Install [parallel](https://www.gnu.org/software/parallel/) to be able to run tests. 1) Install [parallel](https://www.gnu.org/software/parallel/) to be able to run tests.
1) Fork the Github repository. 1) Fork the GitHub repository.
1) Run the following commands. 1) Run the following commands.
``` ```
git clone https://github.com/Chocobozzz/PeerTube git clone https://github.com/Chocobozzz/PeerTube
@ -98,7 +98,7 @@ yarn install --pure-lockfile
``` ```
Note that development is done on the `develop` branch. If you want to hack on 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 PeerTube, you should switch to that branch. Also note that you have to repeat
the `yarn install --pure-lockfile` command. the `yarn install --pure-lockfile` command.
When you create a new branch you should also tell to use your repo for upload 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
sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev
``` ```
Peertube also requires a running redis server, no special setup is needed for PeerTube also requires a running redis server, no special setup is needed for
this. this.
In dev mode, administrator username is **root** and password is **test**. 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
### CI ### CI
PeerTube uses Github actions to run tests every time a commit is pushed or a PR is opened. PeerTube uses GitHub actions to run tests every time a commit is pushed or a PR is opened.
You can find more information about these tasks on the [dedicated documentation](/support/doc/development/ci.md). You can find more information about these tasks on the [dedicated documentation](/support/doc/development/ci.md).
### Monitoring ### Monitoring
@ -288,11 +288,11 @@ To do so, see the [dedicated documentation](/support/doc/development/monitoring.
### Test live stream ### Test live stream
To easily test a live on PeerTube: To easily test a live stream on PeerTube:
* Enable live support in web admin configuration * Enable live support in web admin configuration
* Create a permanent live on the PeerTube instance * Create a permanent live on the PeerTube instance
* Get the **RTMP URL** and the **Live stream key** * Get the **RTMP URL** and the **Live stream key**
* Send the live to PeerTube using `ffmpeg` using a local video: * Send the live stream to PeerTube using `ffmpeg` using a local video:
``` ```
ffmpeg -stream_loop -1 -re -i any-video.mp4 -c copy -f flv rtmp://{RTMP URL}/live/{STREAM KEY} ffmpeg -stream_loop -1 -re -i any-video.mp4 -c copy -f flv rtmp://{RTMP URL}/live/{STREAM KEY}

3
CODE_OF_CONDUCT.md
View File

@ -7,7 +7,6 @@ In order to create an open and welcoming environment, we as contributors and mai
* age * age
* body size * body size
* disability * disability
* ethnicity
* gender identity and expression * gender identity and expression
* level of experience * level of experience
* education * education
@ -63,7 +62,7 @@ We also reserve the right to temporarily or permanently ban any contributor for
## Scope ## Scope
This code of conduct applies whenever you are representing the project or community. For example you may be: This code of conduct applies whenever you are representing the project or community. For example, you may be:
* working in a project space online or in the public (i.e.: github.com, framacolibri.org, IRC) * working in a project space online or in the public (i.e.: github.com, framacolibri.org, IRC)
* using an official project email address * using an official project email address