Difference between revisions of "Components Diagram"
(→Configuration) |
|||
| (46 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| + | = A Typical Deployment = |
||
| − | The following diagram describes a typical deployment for LRM. The LRM system must have access to the projects' repositories and the translation endpoints. |
||
| + | [[File:LRM for CI2.gif]] |
||
| + | * Code and [[Terms_and_Definitions#resourcefiles|resource files]] are stored in repositories such as Subversion or Git which Localyzer has access to. |
||
| + | * Localyzer creates [[Terms_and_Definitions#projectname|Localyzer projects]] for the [[Terms_and_Definitions#resourcefiles|resources files]] and tracks their status using the [[Terms_and_Definitions#LRMDatabase|Localyzer Database]]. |
||
| + | * Localyzer can track when entire resource files need to be translated, for example when there is a new locale. Or when only changes from the previous translations need to be translated. |
||
| + | * Localyzer bundles files to be translated into [[Terms_and_Definitions#prepkit|prep kits]] that can then be given to translation vendors and received back. |
||
| + | * [[Terms_and_Definitions#Jenkins|Jenkins]] is used to automate the scripts to perform many of these tasks. |
||
| + | * The [[Terms_and_Definitions#LingoportDashboardClient|Lingoport Dashboard Client]] pushes the information in the Localyzer reports to the [[Terms_and_Definitions#LingoportDashboardServer|Dashboard Server]] to illustrate the translation status of all projects and if translations are due. |
||
| − | [[File:LRM_Deployment_Diagram.jpg]] |
+ | [[File:LRM_Deployment_Diagram.jpg|500px]] |
== Repositories == |
== Repositories == |
||
| − | + | Several [[Terms_and_Definitions#repository|repository]] types, SVN, Git and TFS, are supported out of the box. Many more can be added to the framework depending on the requirements, provided the repository types support command line calls. |
|
| − | To configure the repository for a project once the |
+ | To configure the repository for a project once the Localyzer system has been installed and configured, please refer to this section: [[Project_Configuration_Files| Project Configuration Files]]. |
| + | The ''[[Project_Configuration_Files#config_vcs.properties|config_vcs.properties]]'' file defines the project repository configuration. |
||
| − | == LRM System == |
||
| + | |||
| − | === LRM === |
||
| + | == Localyzer System == |
||
| − | LRM is composed of a number of jar files and configuration files. |
||
| + | === Localyzer === |
||
| − | To install and configure LRM, please refer to the [[LRM Installation FAQ]]. |
||
| + | Localyzer is composed of a number of jar files and configuration files. |
||
| + | To install and configure Localyzer, please refer to the [[Localyzer Installation]] section. |
||
=== Jenkins === |
=== Jenkins === |
||
| − | Jenkins orchestrates the different tasks and automates a number of |
+ | Jenkins is an open source automation server that orchestrates the different tasks and automates a number of Localyzer tasks by calling scripts. |
To install and configure Jenkins, please refer to these sections: |
To install and configure Jenkins, please refer to these sections: |
||
| − | *[[LRM Jenkins Plugins]] |
+ | *[[LRM Jenkins Plugins |Localyzer Jenkins Plugins]] |
| − | *[[LRM Jenkins Configure System]] |
+ | *[[LRM Jenkins Configure System | Localyzer Jenkins Configure System]] |
| − | *[[LRM Jenkins Jobs]] |
+ | *[[LRM Jenkins Jobs |Localyzer Jenkins Jobs]] |
| + | |||
| + | === Lingoport Dashboard === |
||
| + | The [[Terms_and_Definitions#LingoportDashboard|Lingoport Dashboard]] is composed of two parts, the [[Terms_and_Definitions#LingoportDashboardServer|Dashboard Server]] and the [[Terms_and_Definitions#LingoportDashboardClient|Dashboard Client]]. They can be set up on different systems if necessary. |
||
| − | === Dashboard === |
||
| − | The Dashboard is composed of two parts, the Dashboard server and the Dashboard client. They can be set up on different systems if necessary. |
||
==== Dashboard Server ==== |
==== Dashboard Server ==== |
||
| + | [[File:Lingoport Dashboard.JPG|700px]] |
||
| − | The Dashboard server is a Web application and must be network accessible to the stakeholders, for instance development teams and management, localization managers, QA, and/or translators. It shows the status of the project. |
||
| + | |||
| + | The [[Terms_and_Definitions#LingoportDashboardServer|Dashboard server]] is a Web application and must be network accessible to the stakeholders, for instance development teams and management, localization managers, QA, and/or translators. It shows the status of the [[Terms_and_Definitions#LRMProject|Localyzer projects]]. |
||
| + | |||
==== Dashboard Client ==== |
==== Dashboard Client ==== |
||
| + | Localyzer can create a number of reports regarding the status of projects and translations. |
||
| − | The Dashboard client uses the results of LRM to push data to the Dashboard server. |
||
| + | |||
| + | The Dashboard Client uses the results of the Localyzer report capability to push information to the Dashboard Server to illustrate translation status by locale. |
||
== Translation Systems == |
== Translation Systems == |
||
| − | + | Localyzer connects seamlessly to translation systems. Out of the box, the following are available: |
|
| + | * Lingotek |
||
| + | * FTP |
||
| + | Other TMSs can be added: |
||
| + | * GlobalLink |
||
| + | * MemoQ |
||
| + | * Memosource |
||
| + | * XTM |
||
| + | * WorldServer |
||
| + | Other translation systems may require some custom work to add to the framework without changes to the core installation. |
||
| − | A translation system is typically set for an entire group of projects. |
||
| + | A translation system is typically set for an entire group of projects and can be specified for individual projects as well, using the <code>config_l10n_vendor.xml</code> file located either in the group or the project <code>config</code> directory: |
||
| − | === Lingotek === |
||
| + | * [[Group Configuration Files]] |
||
| − | Lingotek provides a SaaS translation management system. |
||
| + | * [[Project Configuration Files]] |
||
| − | To configure a project to send files back to forth to Lingotek, please refer to this section: |
||
| − | http://wiki.lingoport.com/index.php5?title=Group_Configuration_Files#config_l10n_vendor.xml |
||
| − | === |
+ | === Configuration === |
| + | For most TMSs, the configuration for a project or a group of projects can be done either from : |
||
| − | A file transfer protocol (FTP) endpoint for outgoing files and one for incoming files can be configured. The files sent and received must conform to a naming and a structure convention. |
||
| + | * Jenkins: [[On Boarding a Localyzer Project]] |
||
| − | To configure a project to send files back and forth to FTP, please refer to this section: |
||
| − | + | * optionally, via an XML configuration file: [[Group_Configuration_Files#config_l10n_vendor.xml|config_l10n_vendor.xml]]. |
|
Latest revision as of 14:59, 2 December 2021
Contents
A Typical Deployment
- Code and resource files are stored in repositories such as Subversion or Git which Localyzer has access to.
- Localyzer creates Localyzer projects for the resources files and tracks their status using the Localyzer Database.
- Localyzer can track when entire resource files need to be translated, for example when there is a new locale. Or when only changes from the previous translations need to be translated.
- Localyzer bundles files to be translated into prep kits that can then be given to translation vendors and received back.
- Jenkins is used to automate the scripts to perform many of these tasks.
- The Lingoport Dashboard Client pushes the information in the Localyzer reports to the Dashboard Server to illustrate the translation status of all projects and if translations are due.
Repositories
Several repository types, SVN, Git and TFS, are supported out of the box. Many more can be added to the framework depending on the requirements, provided the repository types support command line calls. To configure the repository for a project once the Localyzer system has been installed and configured, please refer to this section: Project Configuration Files.
The config_vcs.properties file defines the project repository configuration.
Localyzer System
Localyzer
Localyzer is composed of a number of jar files and configuration files. To install and configure Localyzer, please refer to the Localyzer Installation section.
Jenkins
Jenkins is an open source automation server that orchestrates the different tasks and automates a number of Localyzer tasks by calling scripts. To install and configure Jenkins, please refer to these sections:
Lingoport Dashboard
The Lingoport Dashboard is composed of two parts, the Dashboard Server and the Dashboard Client. They can be set up on different systems if necessary.
Dashboard Server
The Dashboard server is a Web application and must be network accessible to the stakeholders, for instance development teams and management, localization managers, QA, and/or translators. It shows the status of the Localyzer projects.
Dashboard Client
Localyzer can create a number of reports regarding the status of projects and translations.
The Dashboard Client uses the results of the Localyzer report capability to push information to the Dashboard Server to illustrate translation status by locale.
Translation Systems
Localyzer connects seamlessly to translation systems. Out of the box, the following are available:
- Lingotek
- FTP
Other TMSs can be added:
- GlobalLink
- MemoQ
- Memosource
- XTM
- WorldServer
Other translation systems may require some custom work to add to the framework without changes to the core installation.
A translation system is typically set for an entire group of projects and can be specified for individual projects as well, using the config_l10n_vendor.xml file located either in the group or the project config directory:
Configuration
For most TMSs, the configuration for a project or a group of projects can be done either from :
- Jenkins: On Boarding a Localyzer Project
- optionally, via an XML configuration file: config_l10n_vendor.xml.
