mirror of
https://gitee.com/mirrors_PX4/PX4-Autopilot.git
synced 2026-05-23 08:17:35 +08:00
Hamish Willee
88d623bedb
* Add vitepress tree * Update existing workflows so they dont trigger on changes in the docs path * Add nojekyll, package.json, LICENCE etc * Add crowdin docs upload/download scripts * Add docs flaw checker workflows * Used docs prefix for docs workflows * Crowdin obvious fixes * ci: docs move to self hosted runner runs on a beefy server for faster builds Signed-off-by: Ramon Roche <mrpollo@gmail.com> * ci: don't run build action for docs or ci changes Signed-off-by: Ramon Roche <mrpollo@gmail.com> * ci: update runners Signed-off-by: Ramon Roche <mrpollo@gmail.com> * Add docs/en * Add docs assets and scripts * Fix up editlinks to point to PX4 sources * Download just the translations that are supported * Add translation sources for zh, uk, ko * Update latest tranlsation and uorb graphs * update vitepress to latest --------- Signed-off-by: Ramon Roche <mrpollo@gmail.com> Co-authored-by: Ramon Roche <mrpollo@gmail.com>
67 lines
2.9 KiB
Markdown
67 lines
2.9 KiB
Markdown
# Translation
|
|
|
|
We'd love your help to translate _QGroundControl_, PX4 Metadata (in QGC), and our guides for PX4, _QGroundControl_ and MAVLink!
|
|
|
|
Our docs (and _QGroundControl_) use the [Crowdin](https://crowdin.com) online tool for translation.
|
|
Crowdin automatically imports source topics from Github and presents new and changed strings for translation and/or review (approval).
|
|
|
|
Crowdin exports the translated documents back out to Github as a "Pull Request" (which the development team periodically review and accept).
|
|
The exported output contains the source document with any translated and approved text replaced with translated strings (i.e. if a string is not translated/is changed, then it will be displayed in English).
|
|
|
|
:::tip
|
|
You will need a (free) [Crowdin account](https://crowdin.com/join) account to join the translation team!
|
|
:::
|
|
|
|
::: info
|
|
The benefit of this system is that the translation closely tracks the source documents.
|
|
Readers will not be mislead by old and out of date translations.
|
|
:::
|
|
|
|
## Getting Started
|
|
|
|
The steps to join our translation tream are:
|
|
|
|
1. Join Crowdin: [https://crowdin.com/join](https://crowdin.com/join)
|
|
1. Open the translation project you want to join:
|
|
- [QGroundControl](https://crowdin.com/project/qgroundcontrol) — QGroundControl UI and hard coded strings.
|
|
- [PX4-Metadata-Translations](https://crowdin.com/project/px4-metadata-translations) — PX4 parameter and event descriptions in QGroundControl.
|
|
- [PX4 User Guide](https://crowdin.com/project/px4-user-guide)
|
|
- [QGroundControl Developer Guide](https://crowdin.com/project/qgroundcontrol-developer-guide)
|
|
- [QGroundControl User Guide](https://crowdin.com/project/qgroundcontrol-user-guide)
|
|
- [MAVLink Guide](https://crowdin.com/project/mavlink)
|
|
1. Select the language you want to translate
|
|
1. Click the **Join** button (next to the text _You must join the translators team to be able to participate in this project_)
|
|
|
|
::: info
|
|
You will be notified once your application to join is accepted.
|
|
:::
|
|
|
|
1. Start translating!
|
|
|
|
## Special Notes
|
|
|
|
### Do not modify prefix text
|
|
|
|
Vuepress uses `:::` to mark the beginning of notes, tips and warning:
|
|
|
|
```html
|
|
:::tip The text for the tip. :::
|
|
```
|
|
|
|
The text for `:::tip` or `:::warning` etc. should not be modified as it defines the colour of the notebox.
|
|
|
|
## Adding a New Language
|
|
|
|
If the language you want to translate is not available then you will need to request it by contacting the project owner (there is a contact link on each project's home page).
|
|
|
|
:::warning
|
|
Maintaining a translation is hard!
|
|
Before you ask us to create a new language, please find a few other people to help you translate!
|
|
:::
|
|
|
|
## Getting Help
|
|
|
|
The _Crowdin_ interface is self explanatory, but there is plenty of additional information on the [knowledgeable](https://support.crowdin.com/).
|
|
|
|
You can also ask for help from translators and developers in the Dronecode community using [our support channels](../contribute/support.md).
|