Difference between revisions of "Prepping a Kit"

From Lingoport Wiki
Jump to: navigation, search
Line 1: Line 1:
  +
====
==<group_name>.<project_name>-PrepKit ==
 
When prepping a kit, i.e. collecting the right files, checking for correctness, sending them to the appropriate location, and notifying the recipients, files move to different locations to ensure they are delivered properly or they can be delivered properly later if some malfunction happened, for instance due to a network outage.
+
When executing the <group_name>.<project_name>-PrepKit 'build' job to prep a kit, <i>i.e. collecting the right files, checking for correctness, sending them to the appropriate location, and notifying the recipients</i>, files move to different locations to ensure they are delivered properly or they can be delivered properly later if some malfunction happened, for instance due to a network outage.
   
 
This section describes how the files are moved
 
This section describes how the files are moved
   
=== From Source to core LRM data ===
+
== From Source to core LRM data ==
 
The first step is to collect the files from the source directly, after a clean checkout/clone from the repository. If all is copacetic, the files to be send for translation are moved under the core LRM data directory, LRM_DATA_HOME, which is typically set to ~/Lingoport_Data/LRM.
 
The first step is to collect the files from the source directly, after a clean checkout/clone from the repository. If all is copacetic, the files to be send for translation are moved under the core LRM data directory, LRM_DATA_HOME, which is typically set to ~/Lingoport_Data/LRM.
   
Line 17: Line 17:
 
</pre>
 
</pre>
   
=== Moving the Prep Kit under staging ===
+
== Moving the Prep Kit under staging ==
 
If that stage is successful, the files are then getting ready to be sent and are placed under the <code>sendkits/lingotek</code> or <code>sendkits/ftp</code> depending on the project configuration:
 
If that stage is successful, the files are then getting ready to be sent and are placed under the <code>sendkits/lingotek</code> or <code>sendkits/ftp</code> depending on the project configuration:
 
<pre>
 
<pre>
Line 36: Line 36:
 
</pre>
 
</pre>
   
=== Sending the Files under staging ===
+
== Sending the Files under staging ==
 
If this has been successful, the next step is to send the files to Lingotek or FTP, depending on the configuration. This may fail due to network problems, server saturation, or other causes. Until the files have successfully been sent, they are kept under staging.
 
If this has been successful, the next step is to send the files to Lingotek or FTP, depending on the configuration. This may fail due to network problems, server saturation, or other causes. Until the files have successfully been sent, they are kept under staging.
   
=== Keeping Track under L10nStreamlining ===
+
== Keeping Track under L10nStreamlining ==
 
L10nStreamlining helps keep track of what was sent and received. The last stage of the Prep Kit process is to move the files which were under <code>staging/sendkits</code> over to
 
L10nStreamlining helps keep track of what was sent and received. The last stage of the Prep Kit process is to move the files which were under <code>staging/sendkits</code> over to
 
<code>L10nStreamlining/<group_name>/projects<project_name>/prepkits/PREP_KIT_2</code>.
 
<code>L10nStreamlining/<group_name>/projects<project_name>/prepkits/PREP_KIT_2</code>.

Revision as of 22:44, 15 April 2015

==

When executing the <group_name>.<project_name>-PrepKit 'build' job to prep a kit, i.e. collecting the right files, checking for correctness, sending them to the appropriate location, and notifying the recipients, files move to different locations to ensure they are delivered properly or they can be delivered properly later if some malfunction happened, for instance due to a network outage.

This section describes how the files are moved

From Source to core LRM data

The first step is to collect the files from the source directly, after a clean checkout/clone from the repository. If all is copacetic, the files to be send for translation are moved under the core LRM data directory, LRM_DATA_HOME, which is typically set to ~/Lingoport_Data/LRM.

For instance, if this is the second prep kit, the base files would be moved under:

<group_name>
├── logs
├── prep_kit
│   └── <project>
│       └── PREP_KIT_2

Moving the Prep Kit under staging

If that stage is successful, the files are then getting ready to be sent and are placed under the sendkits/lingotek or sendkits/ftp depending on the project configuration:

staging
├── ...
├── sendkits
│   └── lingotek
│       ├── <group_name>
│       │   └── <project_name>
│               └── PREP_KIT_2
│                   ├── BaseFileSearch_fr.xml
│                   ├── FilesToPrep.xml
│                   ├── fr
│                   │   ├── file1_en.properties
│                   │   └── file2_en.properties
│                   ├── <project_name>_1_fr.xml
│                   └── IncompletePrepKit.xml

Sending the Files under staging

If this has been successful, the next step is to send the files to Lingotek or FTP, depending on the configuration. This may fail due to network problems, server saturation, or other causes. Until the files have successfully been sent, they are kept under staging.

Keeping Track under L10nStreamlining

L10nStreamlining helps keep track of what was sent and received. The last stage of the Prep Kit process is to move the files which were under staging/sendkits over to L10nStreamlining/<group_name>/projects<project_name>/prepkits/PREP_KIT_2.