Differences

This shows you the differences between two versions of the page.

--- i18n:setting_up_a_new_series_translation [2023/04/26 21:40] – [WIP: updating the instructions] gmcharlton
+++ i18n:setting_up_a_new_series_translation [2024/05/23 17:11] (current) – Introducing screenshots to illistrate configure branch bmagic
@@ Line 1: / Line 1: @@
-====== Setting up a new series translation in Launchpad ======
+======= Setting up a new series translation in Launchpad =======
-Evergreen translations are currently hosted on [[https://translations.launchpad.net/evergreen|Launchpad translations]]. This wiki page will document the basic steps for setting up a new series translation target.
+Evergreen translations that involve PO and POT files are currently hosted on [[https://translations.launchpad.net/evergreen|Launchpad translations]]. (Translations for the Angular staff interface are managed using POEditor). This wiki page will document the basic steps for setting up a new series translation target.
+====== Prerequisites ======
+===== Launchpad Permissions =====
+In order to perform these steps, you must have the following privileges in Launchpad:
+  - Be a member of the [[https://launchpad.net/~evergreen-release|Evergreen Release Team]] team. This is needed in order to attach a bzr branch to the code series and designate branches to import from and export to for the strings.
+  - Be a member of the [[https://launchpad.net/~evergreen-bugs|Evergreen Bugs]] team. This is needed in order to create bzr branches owned by the evergreen-bugs team to follow the naming convention set up by this procedure.
 ===== Install and setup Bazaar =====
@@ Line 9: / Line 17: @@
   - Set launchpad login (replace "launchpadusr" with actual LP username): <code>bzr launchpad-login launchpadusr</code>
-===== Use bzr-git to clone Evergreen git branch =====
-  - Install bzr-git package (if available): <code bash>sudo apt-get install bzr-git</code>
+====== Procedure ======
-  - Clone git repo branch via bzr: <code bash>bzr branch git://git.evergreen-ils.org/Evergreen.git,branch=rel_2_12</code>
-  - Push new bzr clone to Launchpad: <code bash>cd rel_2_12 ; bzr push lp:~launchpadusr/evergreen/rel_2_12</code>
-  - Also, setup a new translation-export bzr branch (TBD)
-===== Setup cron job to sync things =====
+This procedure uses Evergreen 3.11 as an example. When implementing this procedure, replace **rel_3_11** and **3.11** with values appropriate to the series that you are setting up.
-Example crontab entries:<code>
-# update local rel_2_12 at 10:00 pm every day
-22 * * * cd ~/rel_2_12 ; bzr pull > /dev/null 2>&1
-# push to launchpad at 10:10 pm every day
-22 * * * cd ~/rel_2_12 ; bzr push lp:~launchpadusr/evergreen/rel_2_12 > /dev/null 2>&1
-</code>
-===== Setup Launchpad translation for series =====
-TODO: Cleanup these instructions
-  - In Launchpad translations site, go to area for "Set up translations for a series"
-  - Click on the series you want to have setup and choose "automatic import" link
-  - Click the link for "Set it now!" next to the text "This series does not have an official Bazaar branch."
-  - Link to a Bazaar branch already on Launchpad like "~launchpadusr/evergreen/rel_2_12"
-  - Also set the export translations to a branch option with "Choose a target branch" and link to the translation-export branch setup previously for a given series.
-====== WIP: updating the instructions ======
   - View Bazaar branches: https://code.launchpad.net/evergreen/+branches
-	- Import a branch
+	- Import a branch {{translations_import_branch.png}}
 		- Owner: evergreen-bugs
-		- Name: rel_3_8
+		- Name: **rel_3_11**
-		- Git: [[git://git.evergreen-ils.org/Evergreen.git,branch=rel_3_8]]
+		- Git: [[git://git.evergreen-ils.org/Evergreen.git,branch=rel_3_11]]
-		- dest source control is bzr
+		- Target source control is bazaar {{translations_options.png}}
-		- then request the import and wait for to complete
+		- then request the import and wait for to complete {{translations_processing.png}}
-	- After import done, go to overview, select the series, configure series branch, then point at the new branch you just bcreated
+	- After import done, go to overview for Evergreen in Launchpad, select the corresponding series, configure series branch, then point at the new branch you just created
+		- {{:i18n:1lp_configure_branch.png?400|}}
+		- {{:i18n:2lp_spyglass.png?400|}}
+		- {{:i18n:3lp_search_branch.png?400|}}
+		- {{:i18n:4lp_click_update.png?200|}}
 	- Create a bzr checkout:
-		- bzr branch lp:evergreen/3.8
+		- <code>bzr branch lp:evergreen/3.11</code>
-		- cd 3.8
+		- <code>cd 3.11</code>
 	- then push to a new translation-export branch
-		- bzr push lp:~evergreen-bugs/evergreen/translation-export-3.8
+		- <code>bzr push lp:~evergreen-bugs/evergreen/translation-export-3.11</code>
   - Now we have a place for LP to send translation exports
-	- Go to translations
+	- Go to translations https://translations.launchpad.net/evergreen
-	- Choose to do an automatic export for the series
+	- Choose to do an automatic export for the series {{:i18n:screenshot_2023-05-05_175041.png?nolink&400}}
-		- by registering the branch for the series, it recognizs it, so we only need to set the settings
+		- by registering the branch for the series, it recognizes it, so we only need to set the settings
 			- import template and translation
-			- set the translations export branch created earlier
+			- set the translations export branch created earlier {{translations_sync_settings.png}}
-	- may need to request a one-time import to get it kicked off
+		- Once the translation automatic sync is set up, you may need to wait for up to a day for the imports and exports to run for the first time.
-		- may need to wait a day