@@ -69,13 +69,13 @@ Current State
69
69
* The translations for the Open edX Maple Release were never uploaded to Transifex,
70
70
because the automation handled by the edx-transifex-bot never uploaded it.
71
71
* The underlying library and Transifex API (V2) are being deprecated. This has led to
72
- insconsistent behavior by our tooling when we try to automatically manage translations.
72
+ inconsistent behavior by our tooling when we try to automatically manage translations.
73
73
See `this pull request `_ for more details.
74
74
* We have a complex process for managing translations for the named releases. As a
75
- result, the black box nature of the transifex bot and the deprecation of the underlying
75
+ result, the black box nature of the Transifex bot and the deprecation of the underlying
76
76
tooling, this has become more laborious to keep running. Especially because there are
77
77
few people with Admin rights to Transifex and knowledge of the Transifex API; this
78
- could become a reccuring problem with each Open edX release.
78
+ could become a recurring problem with each Open edX release.
79
79
80
80
.. _this pull request : https://github.com/openedx/edx-platform/pull/30567
81
81
@@ -100,7 +100,7 @@ Rationale for consolidating translations files centrally
100
100
* Transifex only allows a one-to-one relationship between repositories and Transifex
101
101
Projects. Organizing all of the translation files into one repository and one Transifex
102
102
Project has a lower labor cost: projects are managed separately so we end up spending
103
- less time tracking translation progress, and debuging translation issues when all
103
+ less time tracking translation progress, and debugging translation issues when all
104
104
translation files are put in the same place. By decreasing the number of projects we
105
105
need to maintain, we can add more content like the MFE translations.
106
106
* A repository that only contains text/binary files, and uses branches to separate
@@ -117,7 +117,7 @@ Move Translation Files to a New Repo
117
117
Translation files (of types .mo and .po) currently exist amongst the code/documentation
118
118
they translate. We will move these translation files from being amongst the
119
119
code/documentation to their own repo. For example, a translation file for the openedx
120
- repository edx-platform _ located at ``edx-platform/conf/locale/en/LC_MESSAGES/django.po ``
120
+ repository ` edx-platform `_ located at ``edx-platform/conf/locale/en/LC_MESSAGES/django.po ``
121
121
would be moved to the new repository with the name openedx-translations _ located at
122
122
``openedx-translation/edx-platform/conf/locale/en/LC_MESSAGES/django.po ``. For easier
123
123
reintegration, translation files will be kept in the same directory structure as the
@@ -154,7 +154,7 @@ translators and reviewers across Transifex projects into the new project associa
154
154
the new repository. In addition, we can save all the progress the Open edX translators
155
155
have accomplished by copying the Transifex Memory, the auto-translation feature that
156
156
allows for Projects with similar strings to be automatically translated, from the old
157
- projects to this new one. Once older projects are made redundnant by the new project,
157
+ projects to this new one. Once older projects are made redundant by the new project,
158
158
they will be deprecated. By moving all the translation files to the same repository we
159
159
can increase the reach of the Transifex Memory feature to help translate similar strings
160
160
across the entire code/documentation base.
@@ -166,7 +166,7 @@ Impact on Translators
166
166
=====================
167
167
168
168
As we approach the end of the translation upgrade process, we will need to tactically
169
- move from multiple transifex projects to a single project. This will require
169
+ move from multiple Transifex projects to a single project. This will require
170
170
coordination with our translators to ensure that moving forward they are providing
171
171
translations in the right place.
172
172
@@ -186,14 +186,14 @@ Impact on Developers
186
186
187
187
While it won’t directly impact the day-to-day workflow of developers, due to the same
188
188
reasons that we impact site operators (new translations location), we will have to update
189
- development tools as well. In addion , we will create new instructions for developers on
189
+ development tools as well. In addition , we will create new instructions for developers on
190
190
how to enable translations for a new service/repo when it comes online.
191
191
192
192
Final State
193
193
***********
194
194
195
195
Repositories that generate translation files will have their translation files generated
196
- and committed via a pull request to the openedx-translation repository via a github
196
+ and committed via a pull request to the openedx-translation repository via a GitHub
197
197
workflow. Once the translation files from edx-platform and other repositories are moved
198
198
to the openedx-translations repository, the `Transifex GitHub App `_ will link a Transifex
199
199
project of a name such as "Open edX Translations" to the openedx-translations repository.
@@ -239,7 +239,7 @@ The source code for the edx-transifex-bot is missing. We could rewrite the curre
239
239
tooling to try to solve the problems encountered in the last two Open edX releases and
240
240
upgrade to the new API, but this approach would require a full rewrite, potentially more
241
241
expensive than doing the rewrite in a way that Transifex more cleanly supports. It should
242
- also be mentioned that GitHub discourages the use of bots and separate bot accounts; theyq
242
+ also be mentioned that GitHub discourages the use of bots and separate bot accounts; they
243
243
strongly recommend using GitHub Apps.
244
244
245
245
Making a Transifex Project for Each Repository
@@ -248,12 +248,12 @@ Making a Transifex Project for Each Repository
248
248
As translation support is provided for more repos, the effort to maintain the
249
249
translations infrastructure increases. A Transifex Project houses the content to be
250
250
translated and needs to be created before any content can be added for translation.
251
- Transifex Projects can only support 1 GitHub repository each and need to be maintained
251
+ Transifex Projects can only support one GitHub repository each and need to be maintained
252
252
separately. Maintaining a Transifex Project involves adjusting configuration files,
253
253
adding new languages, assigning translators to projects, or any other miscellaneous
254
254
irregular tasks that would be time-consuming at a larger scale. If we add a Transifex
255
255
Project, each Transifex Project will need to be maintained separately, making debugging
256
256
issues or tracking the progress of each Transifex Project time-consuming.
257
257
258
258
.. _Transifex GitHub App : https://github.com/apps/transifex-integration
259
- .. _Transifex GitHub Integration configuration file : https://docs.transifex.com/transifex-github-integrations/github-tx-ui#linking-a-specific-project-with-a-github-repository
259
+ .. _Transifex GitHub Integration configuration file : https://docs.transifex.com/transifex-github-integrations/github-tx-ui#linking-a-specific-project-with-a-github-repository
0 commit comments