diff options
author | Chocobozzz <me@florianbigard.com> | 2023-04-04 09:16:53 +0200 |
---|---|---|
committer | Chocobozzz <me@florianbigard.com> | 2023-04-04 09:18:06 +0200 |
commit | 00ee545c2444c35ed0d37df9f91984246aa36124 (patch) | |
tree | 823ab6b93d9b144bc60adef5c69739b0e8fed808 /support/doc/development | |
parent | b5f38b78984c69fd2b4270c50ed58a708174b935 (diff) | |
download | PeerTube-00ee545c2444c35ed0d37df9f91984246aa36124.tar.gz PeerTube-00ee545c2444c35ed0d37df9f91984246aa36124.tar.zst PeerTube-00ee545c2444c35ed0d37df9f91984246aa36124.zip |
Remove $ for bash commands
It prevents easy copy
Diffstat (limited to 'support/doc/development')
-rw-r--r-- | support/doc/development/lib.md | 12 | ||||
-rw-r--r-- | support/doc/development/localization.md | 2 | ||||
-rw-r--r-- | support/doc/development/monitoring.md | 6 | ||||
-rw-r--r-- | support/doc/development/tests.md | 26 |
4 files changed, 23 insertions, 23 deletions
diff --git a/support/doc/development/lib.md b/support/doc/development/lib.md index c43edbacc..3cccaf3d0 100644 --- a/support/doc/development/lib.md +++ b/support/doc/development/lib.md | |||
@@ -5,9 +5,9 @@ | |||
5 | ### Build & Publish | 5 | ### Build & Publish |
6 | 6 | ||
7 | ``` | 7 | ``` |
8 | $ cd client/src/standalone/player/ | 8 | cd client/src/standalone/player/ |
9 | $ npm run build | 9 | npm run build |
10 | $ npm publish --access=public | 10 | npm publish --access=public |
11 | ``` | 11 | ``` |
12 | 12 | ||
13 | ## @peertube/peertube-types | 13 | ## @peertube/peertube-types |
@@ -17,9 +17,9 @@ Typescript definition files generation is controlled by the various `tsconfig.ty | |||
17 | The complete types package is generated via: | 17 | The complete types package is generated via: |
18 | 18 | ||
19 | ``` | 19 | ``` |
20 | $ npm run generate-types-package 4.x.x | 20 | npm run generate-types-package 4.x.x |
21 | $ cd packages/types/dist | 21 | cd packages/types/dist |
22 | $ npm publish --access=public | 22 | npm publish --access=public |
23 | ``` | 23 | ``` |
24 | 24 | ||
25 | > See [scripts/generate-types-package.ts](scripts/generate-types-package.ts) for details. | 25 | > See [scripts/generate-types-package.ts](scripts/generate-types-package.ts) for details. |
diff --git a/support/doc/development/localization.md b/support/doc/development/localization.md index 3021d3659..a38ed6f55 100644 --- a/support/doc/development/localization.md +++ b/support/doc/development/localization.md | |||
@@ -9,7 +9,7 @@ Will generate XLIFF base files for Angular (`angular.xlf`) and JSON files for th | |||
9 | Then, it will merge new translation keys into localized Angular files (`angular.fr-FR.xlf` etc). | 9 | Then, it will merge new translation keys into localized Angular files (`angular.fr-FR.xlf` etc). |
10 | 10 | ||
11 | ``` | 11 | ``` |
12 | $ npm run i18n:update | 12 | npm run i18n:update |
13 | ``` | 13 | ``` |
14 | 14 | ||
15 | 15 | ||
diff --git a/support/doc/development/monitoring.md b/support/doc/development/monitoring.md index 9dcc2d563..93fd1403e 100644 --- a/support/doc/development/monitoring.md +++ b/support/doc/development/monitoring.md | |||
@@ -5,7 +5,7 @@ | |||
5 | To open a report of client build: | 5 | To open a report of client build: |
6 | 6 | ||
7 | ``` | 7 | ``` |
8 | $ npm run build -- --analyze-bundle && npm run client-report | 8 | npm run build -- --analyze-bundle && npm run client-report |
9 | ``` | 9 | ``` |
10 | 10 | ||
11 | ## API benchmark | 11 | ## API benchmark |
@@ -13,11 +13,11 @@ $ npm run build -- --analyze-bundle && npm run client-report | |||
13 | To benchmark the REST API and save result in `benchmark.json`: | 13 | To benchmark the REST API and save result in `benchmark.json`: |
14 | 14 | ||
15 | ``` | 15 | ``` |
16 | $ node dist/scripts/benchmark.js -o benchmark.json | 16 | node dist/scripts/benchmark.js -o benchmark.json |
17 | ``` | 17 | ``` |
18 | 18 | ||
19 | You can also grep on a specific test: | 19 | You can also grep on a specific test: |
20 | 20 | ||
21 | ``` | 21 | ``` |
22 | $ node dist/scripts/benchmark.js --grep homepage | 22 | node dist/scripts/benchmark.js --grep homepage |
23 | ``` | 23 | ``` |
diff --git a/support/doc/development/tests.md b/support/doc/development/tests.md index 6eb499f0c..c4935b70d 100644 --- a/support/doc/development/tests.md +++ b/support/doc/development/tests.md | |||
@@ -5,19 +5,19 @@ | |||
5 | Prepare PostgreSQL user so PeerTube can delete/create the test databases: | 5 | Prepare PostgreSQL user so PeerTube can delete/create the test databases: |
6 | 6 | ||
7 | ```bash | 7 | ```bash |
8 | $ sudo -u postgres createuser you_username --createdb --superuser | 8 | sudo -u postgres createuser you_username --createdb --superuser |
9 | ``` | 9 | ``` |
10 | 10 | ||
11 | Prepare databases: | 11 | Prepare databases: |
12 | 12 | ||
13 | ```bash | 13 | ```bash |
14 | $ npm run clean:server:test | 14 | npm run clean:server:test |
15 | ``` | 15 | ``` |
16 | 16 | ||
17 | Build PeerTube: | 17 | Build PeerTube: |
18 | 18 | ||
19 | ```bash | 19 | ```bash |
20 | $ npm run build | 20 | npm run build |
21 | ``` | 21 | ``` |
22 | 22 | ||
23 | ## Server tests | 23 | ## Server tests |
@@ -27,20 +27,20 @@ $ npm run build | |||
27 | Run docker containers needed by some test files: | 27 | Run docker containers needed by some test files: |
28 | 28 | ||
29 | ```bash | 29 | ```bash |
30 | $ sudo docker run -p 9444:9000 chocobozzz/s3-ninja | 30 | sudo docker run -p 9444:9000 chocobozzz/s3-ninja |
31 | $ sudo docker run -p 10389:10389 chocobozzz/docker-test-openldap | 31 | sudo docker run -p 10389:10389 chocobozzz/docker-test-openldap |
32 | ``` | 32 | ``` |
33 | 33 | ||
34 | Ensure you also have these commands: | 34 | Ensure you also have these commands: |
35 | 35 | ||
36 | ```bash | 36 | ```bash |
37 | $ exiftool --help | 37 | exiftool --help |
38 | $ parallel --help | 38 | parallel --help |
39 | ``` | 39 | ``` |
40 | 40 | ||
41 | Otherwise, install the packages. On Debian-based systems (like Debian, Ubuntu or Mint): | 41 | Otherwise, install the packages. On Debian-based systems (like Debian, Ubuntu or Mint): |
42 | ```bash | 42 | ```bash |
43 | $ sudo apt-get install parallel libimage-exiftool-perl | 43 | sudo apt-get install parallel libimage-exiftool-perl |
44 | ``` | 44 | ``` |
45 | 45 | ||
46 | ### Test | 46 | ### Test |
@@ -48,7 +48,7 @@ $ sudo apt-get install parallel libimage-exiftool-perl | |||
48 | To run all test suites: | 48 | To run all test suites: |
49 | 49 | ||
50 | ```bash | 50 | ```bash |
51 | $ npm run test # See scripts/test.sh to run a particular suite | 51 | npm run test # See scripts/test.sh to run a particular suite |
52 | ``` | 52 | ``` |
53 | 53 | ||
54 | Most of tests can be run using: | 54 | Most of tests can be run using: |
@@ -100,7 +100,7 @@ tail -f test1/logs/peertube.log | npm run parse-log -- --level debug --files - | |||
100 | To run tests on local web browsers (comment web browsers you don't have in `client/e2e/wdio.local.conf.ts`): | 100 | To run tests on local web browsers (comment web browsers you don't have in `client/e2e/wdio.local.conf.ts`): |
101 | 101 | ||
102 | ```bash | 102 | ```bash |
103 | $ PEERTUBE2_E2E_PASSWORD=password npm run e2e:local | 103 | PEERTUBE2_E2E_PASSWORD=password npm run e2e:local |
104 | ``` | 104 | ``` |
105 | 105 | ||
106 | ### Browserstack tests | 106 | ### Browserstack tests |
@@ -108,7 +108,7 @@ $ PEERTUBE2_E2E_PASSWORD=password npm run e2e:local | |||
108 | To run tests on browser stack: | 108 | To run tests on browser stack: |
109 | 109 | ||
110 | ```bash | 110 | ```bash |
111 | $ BROWSERSTACK_USER=your_user BROWSERSTACK_KEY=your_key npm run e2e:browserstack | 111 | BROWSERSTACK_USER=your_user BROWSERSTACK_KEY=your_key npm run e2e:browserstack |
112 | ``` | 112 | ``` |
113 | 113 | ||
114 | ### Add E2E tests | 114 | ### Add E2E tests |
@@ -116,6 +116,6 @@ $ BROWSERSTACK_USER=your_user BROWSERSTACK_KEY=your_key npm run e2e:browserstack | |||
116 | To add E2E tests and quickly run tests using a local Chrome: | 116 | To add E2E tests and quickly run tests using a local Chrome: |
117 | 117 | ||
118 | ```bash | 118 | ```bash |
119 | $ cd client/e2e | 119 | cd client/e2e |
120 | $ ../node_modules/.bin/wdio wdio.local-test.conf.ts # you can also add --mochaOpts.grep to only run tests you want | 120 | ../node_modules/.bin/wdio wdio.local-test.conf.ts # you can also add --mochaOpts.grep to only run tests you want |
121 | ``` | 121 | ``` |