Baseline - Revision history

Olibouban at 18:44, 27 January 2025

2025-01-27T18:44:33Z

← Older revision		Revision as of 18:44, 27 January 2025
Line 1:		Line 1:
	== Baseline Overview ==		== Baseline Overview ==

	After ~~an LRM~~ 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.		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 ~~Baseline's occur~~? ==		== When do Baselining occurs? ==
	When ~~an LRM~~ project is created, it is not baselined. This allows users to make changes and fixes to the project. Once a baseline ~~is created~~, ~~some~~ changes cannot be ~~made~~.		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 ~~automatically~~ created whenever a Prep Kit is sent out~~. They can also be created manually (see [[LRM_Commands_Reference#Create_a_project_baseline]])~~.		Baselines are also created whenever a Prep Kit is sent out, automatically.

	Please note that when the first baseline is created, ~~LRM~~ will make certain assumptions about the resource files from it. It is important to ensure that the ~~LRM~~ configuration is correct before creating your first baseline. ~~For this reason, we recommend allowing~~ the ~~system to do so automatically during the first prep kit~~.		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.

	== ~~Using a~~ Baseline ~~to track previous text updates~~ ==		== The 'Create Baseline' button ==

	~~If onboarding a new project to LRM~~ with ~~a previous translation history, you may wish to catch textual updates prior to onboarding time.~~		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.

	~~<b>Note:</b> This is an advanced use case recommended for experienced users. The following instructions assume you are already familiar with the system.~~

	~~# Find a time in your version control history prior to the textual updates. Checkout the source code from this point~~. ~~If appropriate~~, ~~apply any transforms to~~ the ~~resource files (see /var/lib/jenkins/lingoport/transforms/<your transform>/).~~
	# Create ~~the LRM project~~.
	~~# Verify~~ that the ~~LRM project~~ is correctly configured by viewing the Lingoport Dashboard Resource Manager information. Confirm that all of the correct files tracked (hover over Next Prep Kit Content), and that LRM is not tracking any extraneous files. Check the Dashboard for the correct locales.
	~~# 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>~~
	# Return the project 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.

Rdaly: /* Using a Baseline to track previous text updates */

2019-11-22T22:47:17Z

Using a Baseline to track previous text updates

← Older revision		Revision as of 22:47, 22 November 2019
Line 24:		Line 24:
	If onboarding a new project to LRM with a previous translation history, you may wish to catch textual updates prior to onboarding time.		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 use case recommended for experienced users. The following instructions assume you are already familiar with the system.		<b>Note:</b> This is an advanced use case recommended for experienced users. The following instructions assume you are already familiar with the system.

	# Find a time in your version control history prior to the textual updates. Checkout the source code from this point. If appropriate, apply any transforms to the resource files (see /var/lib/jenkins/lingoport/transforms/<your transform>/).		# Find a time in your version control history prior to the textual updates. Checkout the source code from this point. If appropriate, apply any transforms to the resource files (see /var/lib/jenkins/lingoport/transforms/<your transform>/).

Rdaly: /* Using a Baseline to track previous text updates */

2019-11-22T22:46:36Z

Using a Baseline to track previous text updates

← Older revision		Revision as of 22:46, 22 November 2019
Line 24:		Line 24:
	If onboarding a new project to LRM with a previous translation history, you may wish to catch textual updates prior to onboarding time.		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.		Note: This is an advanced use case 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>/).		# Find a time in your version control history prior to the textual updates. Checkout the source code from this point. If appropriate, apply any transforms to the resource files (see /var/lib/jenkins/lingoport/transforms/<your transform>/).
			# Create the LRM project.
	~~Next, create~~ the LRM project ~~if it does not yet exist~~.		# Verify that the LRM project is correctly configured by viewing the Lingoport Dashboard Resource Manager information. Confirm that all of the correct files tracked (hover over Next Prep Kit Content), and that LRM is not tracking any extraneous files. Check the Dashboard for the correct locales.
			# 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>
	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.		# Return the project 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.

	~~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]]~~

Rdaly: /* When do Baseline's occur? */

2019-11-22T22:35:28Z

When do Baseline's occur?

← Older revision		Revision as of 22:35, 22 November 2019
Line 14:		Line 14:

	== When do Baseline's occur? ==		== When do Baseline's occur? ==
			When an LRM project is created, it is not baselined. This allows users to make changes and fixes to the project. Once a baseline is created, some changes cannot be made.

	Baselines are automatically created whenever a Prep Kit is sent out~~, and when translations are imported~~. They can also be created manually (see [[LRM_Commands_Reference#Create_a_project_baseline]]).		Baselines are automatically created whenever a Prep Kit is sent out. They can also be created manually (see [[LRM_Commands_Reference#Create_a_project_baseline]]).

	Please note that when the first baseline is created, LRM will make certain assumptions about the resource files from it. It is important to ensure that the LRM configuration is correct before creating your first baseline. For this reason, we recommend allowing the system to do so automatically during the first prep kit.		Please note that when the first baseline is created, LRM will make certain assumptions about the resource files from it. It is important to ensure that the LRM configuration is correct before creating your first baseline. For this reason, we recommend allowing the system to do so automatically during the first prep kit.

Rdaly: /* Baseline Overview */

2019-10-09T20:33:04Z

Baseline Overview

← Older revision		Revision as of 20:33, 9 October 2019
Line 1:		Line 1:
	== Baseline Overview ==		== Baseline Overview ==

	After an LRM 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.		After an LRM 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:

Rdaly: /* Baseline Overview */

2019-10-09T20:32:36Z

Baseline Overview

← Older revision		Revision as of 20:32, 9 October 2019
Line 1:		Line 1:
	== Baseline Overview ==		== Baseline Overview ==

	~~When~~ an LRM project is created, ~~the project resources may be fully translated, partially translated, or not tranlated at all. 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.		After an LRM 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:

Rdaly: /* Baseline Overview */

2019-10-09T19:59:20Z

Baseline Overview

← Older revision		Revision as of 19:59, 9 October 2019
Line 1:		Line 1:
	== Baseline Overview ==		== Baseline Overview ==

	When an LRM project is created, the project resources may be fully translated, partially translated or not tranlated at all. 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.		When an LRM project is created, the project resources may be fully translated, partially translated, or not tranlated at all. 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:

Rdaly: /* Baseline Overview */

2019-10-09T19:58:56Z

Baseline Overview

← Older revision		Revision as of 19:58, 9 October 2019
Line 3:		Line 3:
	When an LRM project is created, the project resources may be fully translated, partially translated or not tranlated at all. 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.		When an LRM project is created, the project resources may be fully translated, partially translated or not tranlated at all. 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 ~~Exaple~~:		For Example:

	<code>greeting="Hello!"</code>		<code>greeting="Hello!"</code>

Rdaly: /* Baseline Overview */

2019-10-09T19:58:42Z

Baseline Overview

← Older revision		Revision as of 19:58, 9 October 2019
Line 1:		Line 1:
	== Baseline Overview ==		== Baseline Overview ==

	~~In order to ensure~~ that ~~translations~~ are ~~up to date~~, ~~LRM must track all~~ changes ~~to base resource files. It must also update translation resource files accordingly~~.		When an LRM project is created, the project resources may be fully translated, partially translated or not tranlated at all. 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.

	~~Sometimes this means detecting that keys which exist in the base resource file do not exist in the translation resource file. This is a test that can be done immediately at project setup.~~		For Exaple:

	~~Other times, a project will see alterations to existing text.~~ For ~~instance~~:

	<code>greeting="Hello!"</code>		<code>greeting="Hello!"</code>
Line 13:		Line 11:
	<code>greeting="Hello! Welcome to ACME Supplies."</code>		<code>greeting="Hello! Welcome to ACME Supplies."</code>

	~~In order to track such changes, LRM takes periodic baselines of~~ the ~~resource file status. LRM can then detect when changes have occurred from a previous~~ baseline~~. In this case~~, ~~it would mark~~ the new ~~greeting text for translation in all locales~~.		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 Baseline's occur? ==		== When do Baseline's occur? ==

Masnes: Created page with "== Baseline Overview == In order to ensure that translations are up to date, LRM must track all changes to base resource files. It must also update translation resource files..."

2019-07-29T18:05:22Z

Created page with "== Baseline Overview == In order to ensure that translations are up to date, LRM must track all changes to base resource files. It must also update translation resource files..."

New page

== Baseline Overview ==

In order to ensure that translations are up to date, LRM must track all changes to base resource files. It must also update translation resource files accordingly.

Sometimes this means detecting that keys which exist in the base resource file do not exist in the translation resource file. This is a test that can be done immediately at project setup.

Other times, a project will see alterations to existing text. For instance:

<code>greeting="Hello!"</code>

Might be updated to:

<code>greeting="Hello! Welcome to ACME Supplies."</code>

In order to track such changes, LRM takes periodic baselines of the resource file status. LRM can then detect when changes have occurred from a previous baseline. In this case, it would mark the new greeting text for translation in all locales.

== When do Baseline's occur? ==

Baselines are automatically created whenever a Prep Kit is sent out, and when translations are imported. They can also be created manually (see [[LRM_Commands_Reference#Create_a_project_baseline]]).

Please note that when the first baseline is created, LRM will make certain assumptions about the resource files from it. It is important to ensure that the LRM configuration is correct before creating your first baseline. For this reason, we recommend allowing the system to do so automatically during the first prep kit.

== Using a Baseline to track previous text updates ==

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]]