diff options
Diffstat (limited to 'support')
-rw-r--r-- | support/doc/api/openapi.yaml | 2 | ||||
-rw-r--r-- | support/doc/development/localization.md | 7 | ||||
-rw-r--r-- | support/doc/development/release.md | 20 | ||||
-rw-r--r-- | support/doc/translation.md | 17 |
4 files changed, 44 insertions, 2 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index c23df46a6..7b67b5c64 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -1,7 +1,7 @@ | |||
1 | openapi: 3.0.0 | 1 | openapi: 3.0.0 |
2 | info: | 2 | info: |
3 | title: PeerTube | 3 | title: PeerTube |
4 | version: 1.2.1 | 4 | version: 1.3.0-rc.1 |
5 | contact: | 5 | contact: |
6 | name: PeerTube Community | 6 | name: PeerTube Community |
7 | url: 'https://joinpeertube.org' | 7 | url: 'https://joinpeertube.org' |
diff --git a/support/doc/development/localization.md b/support/doc/development/localization.md index 97e9e2c51..1664532fe 100644 --- a/support/doc/development/localization.md +++ b/support/doc/development/localization.md | |||
@@ -31,3 +31,10 @@ Then, `iso639` files will be merged in `server` files (so we have only one JSON | |||
31 | ``` | 31 | ``` |
32 | $ zanata-cli pull | 32 | $ zanata-cli pull |
33 | ``` | 33 | ``` |
34 | |||
35 | ## Support a new language | ||
36 | |||
37 | * Add it to [/shared/models/i18n/i18n.ts](/shared/models/i18n/i18n.ts) | ||
38 | * Add it to [/scripts/build/client.sh](/scripts/build/client.sh) | ||
39 | * Pull using zanata (that will execute hooks to correctly generate files of this new language) | ||
40 | * Build the application and check the new language correctly works | ||
diff --git a/support/doc/development/release.md b/support/doc/development/release.md new file mode 100644 index 000000000..352a1f0d3 --- /dev/null +++ b/support/doc/development/release.md | |||
@@ -0,0 +1,20 @@ | |||
1 | # Release | ||
2 | |||
3 | * Fix remaining important bugs | ||
4 | * Update [/CHANGELOG.md](/CHANGELOG.md) | ||
5 | * Check migrations: | ||
6 | * `npm run clean:server:test` | ||
7 | * `git checkout master && rm -r ./node_modules && yarn install --pure-lockfile && npm run build:server` | ||
8 | * `NODE_APP_INSTANCE=6 NODE_ENV=test npm run start` and quit after initialization | ||
9 | * `git checkout develop && rm -r ./node_modules && yarn install --pure-lockfile && npm run build:server` | ||
10 | * `NODE_APP_INSTANCE=6 NODE_ENV=test npm run start` and check migrations does not fail | ||
11 | * Run `rm -r node_modules && rm -r client/node_modules && yarn install --pure-lockfile && npm run build` to see if all the supported languages compile correctly | ||
12 | * Update https://peertube2.cpy.re and check it works correctly | ||
13 | * Check Travis tests are green | ||
14 | * Run E2E tests: `BROWSERSTACK_USER=my_user BROWSERSTACK_KEY=my_key npm run e2e` | ||
15 | * Release: `GITHUB_TOKEN=my_token npm run release -- 1.x.x` | ||
16 | * Create a dedicated branch: `git checkout -b release/1.x.x && git push origin release/1.x.x` | ||
17 | * Check the release is okay: https://github.com/Chocobozzz/PeerTube/releases | ||
18 | * Update https://peertube3.cpy.re and check it works correctly | ||
19 | * Update all other instances and check it works correctly | ||
20 | * Communicate on Mastodon & peertube-admin mailing list | ||
diff --git a/support/doc/translation.md b/support/doc/translation.md index 5267c3899..58b52f5f8 100644 --- a/support/doc/translation.md +++ b/support/doc/translation.md | |||
@@ -26,10 +26,25 @@ There are 4 files: | |||
26 | 26 | ||
27 | ## Tips | 27 | ## Tips |
28 | 28 | ||
29 | ### Special tags | ||
30 | |||
29 | You must not translate special tags like `<x id="INTERPOLATION" ... />`. | 31 | You must not translate special tags like `<x id="INTERPOLATION" ... />`. |
30 | 32 | ||
31 | For example: | 33 | For example: |
32 | ```<x id="INTERPOLATION" equiv-text="{{ video.publishedAt | myFromNow }}"/> - <x id="INTERPOLATION_1" equiv-text="{{ video.views | myNumberFormatter }}"/> views``` | 34 | ```<x id="INTERPOLATION" equiv-text="{{ video.publishedAt | myFromNow }}"/> - <x id="INTERPOLATION_1" equiv-text="{{ video.views | myNumberFormatter }}"/> views``` |
33 | 35 | ||
34 | should be in french | 36 | should be in french |
35 | ```<x id="INTERPOLATION" equiv-text="{{ video.publishedAt | myFromNow }}"/> - <x id="INTERPOLATION_1" equiv-text="{{ video.views | myNumberFormatter }}"/> vues``` \ No newline at end of file | 37 | ```<x id="INTERPOLATION" equiv-text="{{ video.publishedAt | myFromNow }}"/> - <x id="INTERPOLATION_1" equiv-text="{{ video.views | myNumberFormatter }}"/> vues``` |
38 | |||
39 | |||
40 | ### Singular/plural | ||
41 | |||
42 | For singular/plural translations, you must translate values inside `{` and `}`. | ||
43 | |||
44 | For example: | ||
45 | |||
46 | ```{VAR_PLURAL, plural, =0 {No videos} =1 {1 video} other {<x id="INTERPOLATION" equiv-text="{{ playlist.videosLength }}"/> videos} }``` | ||
47 | |||
48 | should be in french | ||
49 | |||
50 | ```{VAR_PLURAL, plural, =0 {Aucune vidéos} =1 {1 vidéo} other {<x id="INTERPOLATION" equiv-text="{{ playlist.videosLength }}"/> vidéos} }``` | ||