Skip to content

Commit 9d72427

Browse files
committed
Explain branches in detail for GitHub workflow for Crowdin
1 parent 60df867 commit 9d72427

File tree

2 files changed

+27
-8
lines changed

2 files changed

+27
-8
lines changed

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

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

200+
.. important::
201+
Using the recommended GitHub workflow the GitHub default branch can be
202+
mapped to the Crowdin branch name via the attribute :yaml:`crowdin_branch_name`.
203+
It is recommended that you always use `main` as the Crowdin branch name.
204+
**More than one Crowdin branch (for example via different
205+
GitHub branches) is not supported by the Crowdin Bridge!**
206+
200207
Happy translating!
201208

202209
.. tip::

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

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -177,14 +177,26 @@ 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-
you can approve them yourself. With the next run of the Crowdin Bridge
182-
the translations should be available.
183-
184-
* Only translations provided from the following default branches in your
185-
repository are used: `main`, `master`, `release`, `develop`, `dev`,
186-
`development`. If you use other branches, the translations are not
187-
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+
you can approve them yourself. With the next run of the Crowdin Bridge
185+
the translations should be available.
186+
187+
Integration branch is not recognized
188+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
189+
190+
If the legacy Crowdin <> GitHub integration is used, only translations
191+
provided from the following default branches in your repository are used:
192+
`main`, `master`, `release`, `develop`, `dev`, `development`. If you use
193+
other branches, the translations are not available — even if they are
194+
translated in Crowdin.
195+
196+
It is recommended to configure the
197+
:ref:`GitHub workflow as integration for Crowdin <crowdin-extension-integration-github>`,
198+
this way you define the `crowdin_branch_name` which can be set to
199+
`main` — independently of your GitHub default branch.
188200

189201
.. index:: Crowdin; Reconnect your project
190202
.. _reconnect-your-project:

0 commit comments

Comments
 (0)