|
|
| (57 intermediate revisions by 3 users not shown) |
| Line 1: |
Line 1: |
| = Installation =
| |
| *[[LRM Installation FAQ]]
| |
| *[[LRM Jenkins Plugins]]
| |
| *[[LRM Jenkins Jobs]]
| |
|
| |
|
| = Configuration =
| | *[[Resource Files]] |
| [[LRM Configuration FAQ]]
| | *[[L10n Vendors and Integration]] |
| = On-Boarding =
| | *[[Localyzer Projects |Localyzer Projects]] |
| * The '1 - Automation' tab contains on-boarded jobs which generate the status of the project and pushes it to the dashboard, and pseudo-localizes resource files if necessary. These jobs tend to run whenever files are pushed to the repository for the project.
| | *[[Prep Kits]] |
| * The '2 - Nightlies' tab contains on-boarded jobs which run every day or every night and provide an update to the dashboard and an email to a set of recipients based on the configured frequency.
| | *[[Import Kits]] |
| * The '3- PrepKit' tab contains on-boarded jobs which are triggered by a human intervention to send the kits for translation based on the configured translation endpoint.
| | *[[Advanced Localyzer Features |Advanced Localyzer Features]] |
| | | *[[Advanced Branching]] |
| Each tab has a job setup during configuration. On-boarding a new job consists in copying an exiting job.
| | *[[Localyzer Resource File Comments]] |
| | |
| == On Boarding the Automation Job ==
| |
| === Jenkins Part One ===
| |
| * Go to the '1 - Automation' tab
| |
| * Click 'New Item' and give the job name. A typical job name is 'groupname.projectname', for instance 'Lingoport.javademo';
| |
| * Click 'Copy existing item' and enter the name of the existing job, for instance 'Lingoport.firstjob'
| |
| * ''Use a # sign to comment out the $LRM_HOME/bin/job_automate.sh''
| |
| * Edit the repository location/authentication
| |
| * ''Build the job'': You have the source code downloaded and you check that the repository location is correct.
| |
| * Go to the prompt on that machine and create the LRM project by copying the ProjectDefinition.xml of the existing project and replacing the relevant elements:
| |
| ** group-name
| |
| ** project_name
| |
| ** top-level-dir
| |
| ** pseudo-locale
| |
| ** target-locales
| |
| ** etc.
| |
| * Run ''java -jar <lrmserverpath>/lrm-cli.jar -cp -gn <group_name> -f newProjectDefinition.xml''
| |
| * Verify the project has been created then make sure the files which are handled are correct by running ''java -jar <lrmserverpath>/lrm-cli.jar -gn <group_name-pn <project_name> -r -pi'' and checking the resulting files.
| |
| * If necessary, modify the newProjectDefinition.xml file, run the update-project command, and verify again the results until you are satisfied.
| |
| | |
| === Configuration ===
| |
| When creating a new project, a couple of files are copied from the template directory to the ''<Lingoport_Data>/<L10nStreamlining>/<group_name>/projects/<project_name>/config'' configuration directory:
| |
| * '''config_email_recipients.xml''': Specifies who will get messages (prep kits, import kits, errors, etc.)
| |
| * '''config_vcs.properties''': Specifies SVN or Git properties (between two equal (=) signs!)
| |
| | |
| Other files may be copied under this directory if the project's configuration is more specific than the group configuration files, located under ''<Lingoport_Data>/<L10nStreamlining>/<group_name>/config'':
| |
| * config_due_dates.xml: How the due dates are calculated.
| |
| * '''config_l10n_vendor.properties''': The way to send files to a vendor (Lingotek, WorldServer, or FTP configuration)
| |
| * A couple of other files which typically do not need to be project specific and should very likely remain at the group level.
| |
| | |
| === Jenkins Part Two===
| |
| * Go back to the new job configuration and ''remove the # sign to uncomment $LRM_HOME/bin/job_automate.sh''
| |
| * Run the job: The Dashboard should be updated, some files may be pseudo-localized.
| |
| * Go to the dashboard and set the permissions on the project as appropriate.
| |
| | |
| == On Boarding the Nightly Job ==
| |
| * Go to the '1 - Automation' tab
| |
| * Click 'New Item' and give the job name. A typical job name is 'groupname.projectname', for instance 'Lingoport.javademo';
| |
| * Click 'Copy existing item' and enter the name of the existing job, for instance 'Lingoport.firstjob'
| |
| | |
| = Reference =
| |
| *[[LRM Commands Reference]]
| |
| = FAQ =
| |
| | |
| *[[General LRM FAQ]] | |
| *[[LRM Commands FAQ]] | |
| *[[LRM Open Source Libraries]] | |
| *[[LRM Resources FAQ]] | |
| *[[LRM Error Codes FAQ]] | |
| *[[LRM Dashboard FAQ]] | |
| *[[LRM Tips]] | |
| *[[LRM Fixing Issues]] | |