Skip to content

Commit e11d8fb

Browse files
Explain branches in detail for GitHub workflow for Crowdin (#6265)
Co-authored-by: Chris Müller <coding@brotkrueml.dev>
1 parent ca626de commit e11d8fb

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
@@ -141,17 +141,29 @@ checkbox.
141141
Why is translated content not available in TYPO3?
142142
-------------------------------------------------
143143

144-
* The translated strings are not approved. As an owner of the Crowdin project
145-
(for example, if you're the extension owner) or as proofreader you can approve
146-
strings by yourself. Otherwise please ask in the Slack channel
147-
`#typo3-localization-team <https://typo3.slack.com/app_redirect?channel=CR75200FL>`__
148-
for approval. With the next run of the Crowdin Bridge the translations
149-
should be available (approx. every two hours).
150-
151-
* Only translations provided from the following default branches in your
152-
repository are used: `main`, `master`, `release`, `develop`, `dev`,
153-
`development`. If you use other branches, the translations are not
154-
available — even if they are translated in Crowdin.
144+
Approval is missing
145+
~~~~~~~~~~~~~~~~~~~
146+
147+
The translated strings are not approved. As an owner of the Crowdin project
148+
(for example, if you're the extension owner) or as proofreader you can approve
149+
strings by yourself. Otherwise please ask in the Slack channel
150+
`#typo3-localization-team <https://typo3.slack.com/app_redirect?channel=CR75200FL>`__
151+
for approval. With the next run of the Crowdin Bridge the translations
152+
should be available (approx. every two hours).
153+
154+
Integration branch is not recognized
155+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
156+
157+
If the legacy Crowdin <> GitHub integration is used, only translations
158+
provided from the following default branches in your repository are used:
159+
`main`, `master`, `release`, `develop`, `dev`, `development`. If you use
160+
other branches, the translations are not available — even if they are
161+
translated in Crowdin.
162+
163+
It is recommended to configure the
164+
:ref:`GitHub workflow as integration for Crowdin <crowdin-extension-integration-github>`,
165+
this way you define the `crowdin_branch_name` which can be set to
166+
`main` — independently of your GitHub default branch.
155167

156168
.. index:: Crowdin; Reconnect your project
157169
.. _reconnect-your-project:

0 commit comments

Comments
 (0)