-
Notifications
You must be signed in to change notification settings - Fork 16
Add pull/push workflow for translations #106
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
5638d42 to
092ba35
Compare
| on: | ||
| pull_request: | ||
| paths: | ||
| - 'doc/**/*' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - 'doc/**/*' | |
| - 'doc/**/*.rst' | |
| - 'doc/conf.py' | |
| - '.github/workflows/push-translation.yml' |
| on: | ||
| push: | ||
| paths: | ||
| - 'doc/**/*' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - 'doc/**/*' | |
| - 'doc/**/*.rst' | |
| - 'doc/locale/**/*.po' | |
| - '.github/workflows/upload-translations.yml' |
| ci/helm-chart/templates/crds/tarantool.io_*s_crd.yaml | ||
| ci/helm-chart/templates/crds/tarantool_*_cr.yaml | ||
|
|
||
| doc/locale/en/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| doc/locale/en/ | |
| doc/locale/en/ | |
| doc/output/ |
- add cleanup.py for re-arranging po files - push translation for pushing sources to crowdin on pull request when rst is changed - add pull-translation.yml for getting translations from crowdin on demand when translation is ready Closes #104
092ba35 to
3baec8f
Compare
| push: | ||
| paths: | ||
| - 'doc/**/*.rst' | ||
| - 'doc/locale/**/*.po' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do I need to run a upload when this file changes?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We merge translation files from a PR and then re-upload translations back to Crowdin. Unfortunately, Crowdin cannot just "merge" translations from its own branch.
| @@ -0,0 +1,807 @@ | |||
|
|
|||
| msgid "Tarantool Cartridge on Kubernetes" | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm confused. Shouldn't the translation result be in the .po files?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Translation can be in .po files and only there. But translation is done by humans, and they couldn't do it yet, and won't be able to do until this PR gets merged.
|
How to understand that the translation is ready? |

Documentation sources are .rst files where a tech writer or a developer writes documentation. As soon as we have two languages supported on our website we need to maintain translated 100% of the documentation. For translation, we use Crowdin - saas solution for translating any texts.

While a new PR with changes in .rst is opened, the translations for these changes are preparing by translators in Crowdin.
When the translations are ready we can run Pull translations job to download and commit translations into the PR branch.
This diagram shows how the process works:
Closes #104