Difference between revisions of "Baseline"
(→When do Baseline's occur?) |
|||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
== Baseline Overview == |
== Baseline Overview == |
||
| − | After |
+ | After a Localyzer project is created, but before the first prep kit, a baseline is created that will populate the database with the current state of the project. If any files are changed before the prep kit, then those changes can be tracked. |
For Example: |
For Example: |
||
| Line 13: | Line 13: | ||
If the baseline was created with the original string, then the prep kit will know that the string has changed and send the new value to be translated. |
If the baseline was created with the original string, then the prep kit will know that the string has changed and send the new value to be translated. |
||
| − | == When do |
+ | == When do Baselining occurs? == |
| − | When |
+ | When a Localyzer project is created, it is '''not''' baselined. This allows users to make changes and fixes to the project. Once the configuration looks right, using the Localyzer Report page or the Validation button in Edit, click the Create a baseline. At this point, changes to existing files will be tracked. Some Localyzer project configuration cannot be changed. |
| − | Baselines are |
+ | Baselines are also created whenever a Prep Kit is sent out, automatically. |
| − | Please note that when the first baseline is created, |
+ | Please note that when the first baseline is created, Localyzer will make certain assumptions about the resource files from it. It is important to ensure that the Localyzer configuration is correct before creating your first baseline. Hence the 'validation' button when editing or creating a project. |
| − | == |
+ | == The 'Create Baseline' button == |
| + | Starting with 2.3, the Create Baseline button only appears when baselining may be necessary. Before clicking that button, please make sure that the configuration is done correctly. |
||
| − | If onboarding a new project to LRM with a previous translation history, you may wish to catch textual updates prior to onboarding time. |
||
| − | |||
| − | Note: This is an advanced usecase recommended for experienced users. The following instructions assume you are already familiar with the system. |
||
| − | |||
| − | To do so, first find a time in your version control history prior to the textual updates. Checkout the sourcecode from this point. If appropriate, apply any transforms to the resource files (see /var/lib/jenkins/lingoport/transforms/<your transform>/). |
||
| − | |||
| − | Next, create the LRM project if it does not yet exist. |
||
| − | |||
| − | Verify that the LRM project is correctly configured by running a project inspect report <code>java -jar ~jenkins/lingoport/lrm-server-<version>/lrm-cli.jar -r --project-inspect --group-name <your group> --project-name <your project></code>. Review the report to confirm that all of the correct files tracked, and that LRM is not tracking any extraneous files. It is recommended that you check the report both for the base locale (most commonly English) and one of the target locales. |
||
| − | |||
| − | Once you have confirmed the project is correctly configured, you can run the baseline with the following command: <code>java -jar ~jenkins/lingoport/lrm-server-<version>/lrm-cli.jar --create-baseline --group-name <your group> --project-name <your project></code> |
||
| − | |||
| − | With this finished, return to the latest state of the source per source control. To see what changes were picked up, you may then optionally create a similar test project for the same source without the baseline and compare the result. |
||
| − | |||
| − | |||
| − | See also: |
||
| − | |||
| − | [[LRM_Fixing_Issues#Modified_text_does_not_seem_to_be_recognized_as_a_change_in_my_base_resource_file._What_is_wrong]] |
||
Latest revision as of 18:44, 27 January 2025
Baseline Overview
After a Localyzer project is created, but before the first prep kit, a baseline is created that will populate the database with the current state of the project. If any files are changed before the prep kit, then those changes can be tracked.
For Example:
greeting="Hello!"
Might be updated to:
greeting="Hello! Welcome to ACME Supplies."
If the baseline was created with the original string, then the prep kit will know that the string has changed and send the new value to be translated.
When do Baselining occurs?
When a Localyzer project is created, it is not baselined. This allows users to make changes and fixes to the project. Once the configuration looks right, using the Localyzer Report page or the Validation button in Edit, click the Create a baseline. At this point, changes to existing files will be tracked. Some Localyzer project configuration cannot be changed.
Baselines are also created whenever a Prep Kit is sent out, automatically.
Please note that when the first baseline is created, Localyzer will make certain assumptions about the resource files from it. It is important to ensure that the Localyzer configuration is correct before creating your first baseline. Hence the 'validation' button when editing or creating a project.
The 'Create Baseline' button
Starting with 2.3, the Create Baseline button only appears when baselining may be necessary. Before clicking that button, please make sure that the configuration is done correctly.
