Skip to content

Commit f98bafa

Browse files
authored
Explain branches in detail for GitHub workflow for Crowdin (#6195)
1 parent dd95a9d commit f98bafa

File tree

2 files changed

+30
-11
lines changed

2 files changed

+30
-11
lines changed

Documentation/ApiOverview/Localization/TranslationServer/Crowdin/ExtensionIntegration.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,13 @@ Step-by-step instructions for GitHub
221221
``<source>`` and ``<target>`` elements. If the ``<source>`` elements are missing,
222222
Crowdin will not be able to match the translations with the original English labels.
223223

224+
.. important::
225+
Using the recommended GitHub workflow the GitHub default branch can be
226+
mapped to the Crowdin branch name via the attribute :yaml:`crowdin_branch_name`.
227+
It is recommended that you always use `main` as the Crowdin branch name.
228+
**More than one Crowdin branch (for example via different
229+
GitHub branches) is not supported by the Crowdin Bridge!**
230+
224231
3. Approve imported translations
225232

226233
After importing existing translations, they will arrive in Crowdin in an

Documentation/ApiOverview/Localization/TranslationServer/Crowdin/Faq.rst

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -177,17 +177,29 @@ checkbox.
177177
Why is translated content not available in TYPO3?
178178
-------------------------------------------------
179179

180-
* The translated strings are not approved. As an owner of the Crowdin project
181-
(for example, if you're the extension owner) or as proofreader you can approve
182-
strings by yourself. Otherwise please ask in the Slack channel
183-
`#typo3-localization-team <https://typo3.slack.com/app_redirect?channel=CR75200FL>`__
184-
for approval. With the next run of the Crowdin Bridge the translations
185-
should be available (approx. every two hours).
186-
187-
* Only translations provided from the following default branches in your
188-
repository are used: `main`, `master`, `release`, `develop`, `dev`,
189-
`development`. If you use other branches, the translations are not
190-
available — even if they are translated in Crowdin.
180+
Approval is missing
181+
~~~~~~~~~~~~~~~~~~~
182+
183+
The translated strings are not approved. As an owner of the Crowdin project
184+
(for example, if you're the extension owner) or as proofreader you can approve
185+
strings by yourself. Otherwise please ask in the Slack channel
186+
`#typo3-localization-team <https://typo3.slack.com/app_redirect?channel=CR75200FL>`__
187+
for approval. With the next run of the Crowdin Bridge the translations
188+
should be available (approx. every two hours).
189+
190+
Integration branch is not recognized
191+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
192+
193+
If the legacy Crowdin <> GitHub integration is used, only translations
194+
provided from the following default branches in your repository are used:
195+
`main`, `master`, `release`, `develop`, `dev`, `development`. If you use
196+
other branches, the translations are not available — even if they are
197+
translated in Crowdin.
198+
199+
It is recommended to configure the
200+
:ref:`GitHub workflow as integration for Crowdin <crowdin-extension-integration-github>`,
201+
this way you define the `crowdin_branch_name` which can be set to
202+
`main` — independently of your GitHub default branch.
191203

192204
.. index:: Crowdin; Reconnect your project
193205
.. _reconnect-your-project:

0 commit comments

Comments
 (0)