You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/development/release-checklist.md
+14-1Lines changed: 14 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -90,7 +90,20 @@ This will automatically update the schema file at `contrib/generated_schema.json
90
90
91
91
### Update & Compile Translations
92
92
93
-
Updated language translations should be pulled from [Transifex](https://app.transifex.com/netbox-community/netbox/dashboard/) and re-compiled for each new release. Follow the documented process for [updating translated strings](./translations.md#updating-translated-strings) to do this.
93
+
Updated language translations should be pulled from [Transifex](https://app.transifex.com/netbox-community/netbox/dashboard/) and re-compiled for each new release. First, retrieve any updated translation files using the Transifex CLI client:
94
+
95
+
```no-highlight
96
+
tx pull
97
+
```
98
+
99
+
Then, compile these portable (`.po`) files for use in the application:
100
+
101
+
```no-highlight
102
+
./manage.py compilemessages
103
+
```
104
+
105
+
!!! tip
106
+
Consult the translation documentation for more detail on [updating translated strings](./translations.md#updating-translated-strings) if you've not set up the Transifex client already.
Copy file name to clipboardExpand all lines: docs/development/translations.md
+13-8Lines changed: 13 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,26 +16,31 @@ To update the English `.po` file from which all translations are derived, use th
16
16
17
17
Then, commit the change and push to the `develop` branch on GitHub. Any new strings will appear for translation on Transifex automatically.
18
18
19
+
!!! note
20
+
It is typically not necessary to update source strings manually, as this is done nightly by a [GitHub action](https://github.com/netbox-community/netbox/blob/develop/.github/workflows/update-translation-strings.yml).
21
+
19
22
## Updating Translated Strings
20
23
21
24
Typically, translated strings need to be updated only as part of the NetBox [release process](./release-checklist.md).
22
25
23
26
Check the Transifex dashboard for languages that are not marked _ready for use_, being sure to click _Show all languages_ if it appears at the bottom of the list. Use machine translation to round out any not-ready languages. It's not necessary to review the machine translation immediately as the translation teams will handle that aspect; the goal at this stage is to get translations included in the Transifex pull request.
24
27
25
-
To update translated strings, start by initiating a sync from Transifex. From the Transifex dashboard, navigate to Settings > Integrations > GitHub > Manage, and click the **Manual Sync** button at top right.
28
+
To download translated strings automatically, you'll need to:
1. Install the [Transifex CLI client](https://github.com/transifex/cli)
31
+
2. Generate a [Transifex API token](https://app.transifex.com/user/settings/api/)
28
32
29
-
Enter a threshold percentage of 1 (to ensure all translations are captured) and select the `develop` branch, then click **Sync**. This will initiate a pull request to GitHub to update any newly modified translation (`.po`) files.
33
+
Once you have the client set up, run the following command:
30
34
31
-
!!! tip
32
-
The new PR should appear within a few minutes. If it does not, check that there are in fact new translations to be added.
This will download all portable (`.po`) translation files from Transifex, updating them locally as needed.
35
40
36
-
Once the PR has been merged, the updated strings need to be compiled into new `.mo` files so they can be used by the application. Update the `develop` branch locally to pull in the changes from the Transifex PR, then run Django's [`compilemessages`](https://docs.djangoproject.com/en/stable/ref/django-admin/#django-admin-compilemessages) management command:
41
+
Once retrieved, the updated strings need to be compiled into new `.mo` files so they can be used by the application. Run Django's [`compilemessages`](https://docs.djangoproject.com/en/stable/ref/django-admin/#django-admin-compilemessages) management command to compile them:
0 commit comments