Quitter le mode Zen
75
support/documentation/content/en/contributing/document/_index.md
Anglais type: Plain text
When a new plugin version is released, or when documentation is updated, plugin maintainers will merge the `main` branch to the `documentation` branch. This will trigger github and gitlab pipelines, and update published documentation.
0/2350 · 235
76
support/documentation/content/en/contributing/document/_index.md
Anglais type: Title ##
Translations
0/120 · 12
77
support/documentation/content/en/contributing/document/_index.md
Anglais type: Plain text
The principal language is english (`en` code).
0/460 · 46
78
support/documentation/content/en/contributing/document/_index.md
Anglais type: Plain text
The `support/documentation/content/en` folder contains only english documentation files.
0/880 · 88
79
support/documentation/content/en/contributing/document/_index.md
Anglais type: Plain text
Documentation is translated using Weblate (see the [translation documentation](/peertube-plugin-livechat/contributing/translate/)). To do so, we use the [po4a tool](https://po4a.org/), as we will se later in this page.
0/2190 · 219
80
support/documentation/content/en/contributing/document/_index.md
Anglais type: Title ##
Add a new language
0/180 · 18
81
support/documentation/content/en/contributing/document/_index.md
Anglais type: Plain text
In the `support/documentation/config.toml` file, please copy and modify the `[Languages.fr]` section.
0/1010 · 101
82
support/documentation/content/en/contributing/document/_index.md
Anglais type: Plain text
If the translations are not complete, it does not matter, english will be used for missing strings.
0/990 · 99
83
support/documentation/content/en/contributing/document/_index.md
Anglais type: Title ##
Preview
0/100 · 7
84
support/documentation/content/en/contributing/document/_index.md
Anglais type: Plain text
To preview your modifications, just run:
0/400 · 40
85
support/documentation/content/en/contributing/document/_index.md
Anglais type: Fenced code block (bash)
hugo serve -s support/documentation/
0/370 · 37
86
support/documentation/content/en/contributing/document/_index.md
Anglais type: Plain text
Then open your browser on the address [http://localhost:1313/peertube-plugin-livechat/](http://localhost:1313/peertube-plugin-livechat/). This page will automatically refresh on each modification.
0/1970 · 197
87
support/documentation/content/en/contributing/document/_index.md
Anglais type: Title ##
Update localization files and generate documentation translations
0/650 · 65
88
support/documentation/content/en/contributing/document/_index.md
Anglais type: Plain text
For now, you only have the english version. To update documentation strings, and generate translations, you have to run the `doc-translate.sh` script.
0/1510 · 151
89
support/documentation/content/en/contributing/document/_index.md
Anglais type: Plain text
To do so, make sure you have `po4a` (version >= 0.69) installed on your computer.
0/820 · 82
90
support/documentation/content/en/contributing/document/_index.md
Anglais type: Plain text
Some linux distro (like Debian Bullseye for example) have too old version of `po4a`. Please make sure to install a compatible version. If you are using Debian Bullseye for example, you can download the Bookworm po4a.deb file from [https://packages.debian.org](https://packages.debian.org/bookworm/all/po4a/download), and install it manually.
0/3430 · 343
91
support/documentation/content/en/contributing/document/_index.md
Anglais type: Plain text
To handle translations, just do:
0/320 · 32
92
support/documentation/content/en/contributing/document/_index.md
Anglais type: Fenced code block (bash)
npm run doc:translate
0/220 · 22
93
support/documentation/content/en/contributing/document/_index.md
Anglais type: Plain text
You can then preview the result using `hugo serve -s support/documentation/`, and using the language selector.
0/1100 · 110
94
support/documentation/content/en/contributing/document/_index.md
Anglais type: Title ##
Write documentation
0/190 · 19