Difference between revisions of "Individual Project Tasks"

From Lingoport Wiki
Jump to: navigation, search
(→‎Clean workspace and run project)
(→‎Localyzer)
 
(92 intermediate revisions by 3 users not shown)
Line 1: Line 1:
  +
= Introduction =
  +
[[File:ProjectOverview2.jpg|700px|center]]
  +
When a user selects a project name from the Projects page, the Project Overview page comes up with a summary of the project. There are a number of tabs on the top of the page. The tab that is selected is highlighted. For this example the Overview button [[File:OverviewIconSelected.jpg|60px]] is highlighted for the Project Overview page.
  +
  +
* '''Overview''' - a summary of the project, showing the data source, history, and a summary of Globalyzer and Localyzer configuration
  +
* '''Globalyzer''' - a detail of the Globalyzer information including the number of issues found
  +
* '''Localyzer''' - a detail of the Localyzer information including the locales and translation status
  +
* '''Issues''' - detailed information about the Globalyzer and Localyzer issues
  +
* '''Logs''' - report of the various actions performed on the project.
  +
* '''Configure''' - allows the user to modify the project.
  +
 
= Analyze Project =
  
= Analyze Project =
 
[Admin, Manager]
  
[Admin, Manager]
  +
  +
[[File:InProcessAnalyzeProject.jpg|700px|center]]
  +
  +
The Analyze Project icon [[File:AnalyzeProjectIcon.jpg|30px]] will run the project. When the button is selected, the icon will be shown twirling and a message will come up in the upper left about the job processing.
   
 
= Overview =
  
= Overview =
 
[Admin, Manager, Developer, Translator]
  
[Admin, Manager, Developer, Translator]
  +
  +
[[File:ProjectOverview2.jpg|700px|center]]
  +
  +
  +
Once a project is created, selecting its name will open the Project Overview. Note that the Overview tab [[File:OverviewIconSelected.jpg|60px]] on the top is highlighted. The Overview page is a project summary page, showing the Globalyzer and Localyzer summaries and the Project History. Any of the analysis lines are selectable and will open the corresponding logs.
  +
  +
The Analyze project button [[File:AnalyzeProjectIcon.jpg|30px]] will run the project.
  +
 
= Globalyzer =
 
= Globalyzer =
 
[Admin, Manager, Developer, Translator]
  
[Admin, Manager, Developer, Translator]
  +
  +
[[File: GlobalyzerReport.jpg|700px|center]]
  +
  +
The Globalyzer Icon [[File:GlobalyzerIcon2.jpg|60px]] opens the Globalyzer Report page with the details of the Globalyzer analysis.
  +
  +
* '''Total Remaining Issues''' - all the issues that Globayzer has identified. This card is selectable and will take you to the Issues page.
  +
* '''Total Issues Fixed''' - how many issues have been fixed since the project was created.
  +
* '''Total Issues Density''' - number of issues divided by the number of lines of code that were scanned.
  +
* '''Issues Types Breakdown''' - What types of issues were found.
  +
* '''Issues Priorities Breakdown''' or '''Issues Severities Breakdown'''- A list of the severity of the issues. This can be toggled in the Advanced Settings.
  +
* '''Issue Scans Breakdown''' - The rulesets used and the items scanned for.
  +
 
= Localyzer =
 
= Localyzer =
  +
 
[Admin, Manager, Developer, Translator]
  
[Admin, Manager, Developer, Translator]
  +
−
= Project configuration =
 
  +
[[File:LocalyzerReport.jpg|700px|center]]
−
[Admin, Manager]
  
  +
−
= Console logs =
 
  +
The Localyzer Icon [[File:LocalyzerIcon2.jpg|60px]] opens up the Localyzer Report page. The Localyzer page has a number of icons on the left side for actions that can be done.
−
[Admin, Manager, Developer, Translator]
  
  +
−
= Code browser =
 
  +
[[File:SendKitToTranslation.jpg|30px]] '''Send kit to translation''' - send the latest prep kit to be translated at the specified Translation Management System or Machine Translation engine.
  +
  +
[[File:CheckImportIcon.jpg|30px]] '''Check Import''' - Check the translation management system to see if translations are available to import. If previous translations passed the incoming checks but failed on pushing to the repository, Check Import will try again pushing to the repository those checked files.
  +
  +
[[File:DeactivateLastTranslationKitIcon.jpg|30px]] '''Deactivate last translation kit''' - deactivate the last translation kit that was sent. A translation kit cannot be deactivated if any part of it has been imported.
  +
  +
[[File:ResetAllTranslationKitsIcon.jpg|30px]] '''Reset all translation kits''' - this is used as a reset for the project.
  +
  +
[[File:CreateProjectBaselineIcon.jpg|30px]] '''Create project baseline''' - Set the baseline so that the database can keep track of translation changes and imports. While creating and configuring the project, it does not have a baseline.
  +
  +
= String Manager =
  +
  +
== Introduction video ==
  +
Click on the image below to watch a String Manager introductory video:
  +
[[File:String Manager Video.jpg|200px|center|link=https://www.youtube.com/watch?v=lO1THJAhXSc&ab_channel=Lingoport]]
  +
  +
== Overview ==
 
[Admin, Manager, Developer, Translator]
  
[Admin, Manager, Developer, Translator]
  +
  +
[[File:String Manager.jpg|700px|center]]
  +
  +
String manager provides visibility into each key/value pair managed by Localyzer.
  +
  +
From the search box input text, find strings that match by their values, by their keys, by their filename.
  +
Filter strings that need to be sent, or have been sent and are not yet translated, or strings which are fully translated.
  +
Sort strings based on the text itself, the key, the filename, or the time it was found.
  +
  +
* In the screen shot above, strings that match 'model' and are 'to be sent' are displayed.
  +
  +
Strings can be set 'to be reviewed', or 'reviewed', or neither. Certain strings will be marked 'to be reviewed' by the system. Filtering allows to select strings based on the status of the string.
  +
  +
A link for a specific resource points the browser to GitHub, GitLab or Bitbucket repository/project/branch/key-value pair. Typically, only developers will have access to their repositories and modify source strings.
  +
  +
'''Developers''' create and maintain the '''source''' strings, and if some strings need to be changed, only developers can change them. Users without access to the repository can copy the link and send it to the development team with some explanation, via Slack, Teams, Email, etc.
  +
  +
'''Localyzer''' makes changes to the '''target files''' with translations, pseudo-translation, context files, or LocalyzerQA type files. Developers should not modify those, especially outside of the branch where Localyzer pushed them, for fear of merge conflicts.
  +
 
= Issues =
  
= Issues =
 
[Admin, Manager, Developer, Translator]
  
[Admin, Manager, Developer, Translator]
  +
  +
[[File:Issues.jpg|700px|center]]
  +
  +
The Issues icon [[File:IssuesIcon.jpg|60px]] opens the Issues page and will show all the Globalyzer and Localyzer issues. Once the issues page is open, the issues can be searched, filtered and sorted.
  +
  +
[[File:IssuesDetail.jpg|700px|center]]
  +
Selecting an issue in the list will show more detail about the issue, including its status, type and priority.
  +
*'''Go to line in source code''' - will take the user to the line of code in the repository, for users with repository access.
  +
*'''Learn more about this issue''' - will open up documentation about the issue.
  +
*'''Comments''' - any comments can be added about Globalyzer issues. They will remain after further analyses.
  +
  +
= Project logs =
  +
[Admin, Manager, Developer, Translator]
  +
  +
[[File:ProjectLogs.jpg|700px|center]]
  +
  +
The Console Logs icon [[File:LogsIcon.jpg|60px]] opens up the logs to show when the project has been analyzed. Selecting any of the lines will open the log and show more detail.
  +
  +
[[File:ProjectLogDetail.jpg|700px|center]]
  +
  +
In this example:
  +
* The user making the change is '''testAdmin'''
  +
* The version of Command Center is given
  +
* One setting in the '''General Settings''' was changed
  +
** Tags were modified on the project: '''FTP''' to '''FTP''' and '''Build 5'''
  +
  +
= Edit Project configuration =
  +
[Admin, Manager]
  +
  +
[[File:EditProjectConfiguration.jpg|700px|center]]
  +
  +
The Edit icon [[File:ConfigureIcon.jpg|60px]] will open the Edit Project Configuration page. There are several icons on the left side of the page.
  +
  +
[[File:ValidateProjectIcon.jpg|30px]] - validate the Localyzer configuration finds the resource files.
  +
  +
[[File:DuplicateProjectIcon.jpg|30px]] - make a copy of this project
  +
  +
[[File:CleanProjectWorkspaceIcon.jpg|30px]] - refresh the project
  +
  +
[[File:DeleteProjectIcon.jpg|30px]] - remove the project from Command Center
  +
  +
  +
  +
[[General Settings]]
  +
  +
[[Data Source Settings]]
  +
  +
[[Access Settings]]
  +
  +
[[Globalyzer Settings]]
  +
  +
[[Localyzer Settings]]
  +
  +
== Edit a project ==
  +
  +
There are multiple ways to get to edit a project.
  +
  +
[[File:EditProject1.jpg|700px|center]]
  +
  +
First, from the Projects page, hover over the project and the Edit button will appear.
  +
  +
  +
[[File:EditProject2.jpg|700px|center]]
  +
  +
Second, select the project name (or the Globalyzer or Localyzer icon) to go to the Overview, Globalyzer or Localyzer page. Select the Configure button on the top to get to the Edit Project Configuration page.
  +
  +
  +
[[File:EditProjectConfiguration.jpg|700px|center]]
  +
  +
From this page, any of the settings can be changed.
  +
  +
  +
When changes are made and saved, a notice appears at the top of the screen about the project being updated. The project does not run until it is manually run or by an automated task.

Latest revision as of 15:29, 2 October 2024

Introduction

ProjectOverview2.jpg

When a user selects a project name from the Projects page, the Project Overview page comes up with a summary of the project. There are a number of tabs on the top of the page. The tab that is selected is highlighted. For this example the Overview button OverviewIconSelected.jpg is highlighted for the Project Overview page.

  • Overview - a summary of the project, showing the data source, history, and a summary of Globalyzer and Localyzer configuration
  • Globalyzer - a detail of the Globalyzer information including the number of issues found
  • Localyzer - a detail of the Localyzer information including the locales and translation status
  • Issues - detailed information about the Globalyzer and Localyzer issues
  • Logs - report of the various actions performed on the project.
  • Configure - allows the user to modify the project.

Analyze Project

[Admin, Manager]

InProcessAnalyzeProject.jpg

The Analyze Project icon AnalyzeProjectIcon.jpg will run the project. When the button is selected, the icon will be shown twirling and a message will come up in the upper left about the job processing.

Overview

[Admin, Manager, Developer, Translator]

ProjectOverview2.jpg


Once a project is created, selecting its name will open the Project Overview. Note that the Overview tab OverviewIconSelected.jpg on the top is highlighted. The Overview page is a project summary page, showing the Globalyzer and Localyzer summaries and the Project History. Any of the analysis lines are selectable and will open the corresponding logs.

The Analyze project button AnalyzeProjectIcon.jpg will run the project.

Globalyzer

[Admin, Manager, Developer, Translator]

GlobalyzerReport.jpg

The Globalyzer Icon GlobalyzerIcon2.jpg opens the Globalyzer Report page with the details of the Globalyzer analysis.

  • Total Remaining Issues - all the issues that Globayzer has identified. This card is selectable and will take you to the Issues page.
  • Total Issues Fixed - how many issues have been fixed since the project was created.
  • Total Issues Density - number of issues divided by the number of lines of code that were scanned.
  • Issues Types Breakdown - What types of issues were found.
  • Issues Priorities Breakdown or Issues Severities Breakdown- A list of the severity of the issues. This can be toggled in the Advanced Settings.
  • Issue Scans Breakdown - The rulesets used and the items scanned for.

Localyzer

[Admin, Manager, Developer, Translator]

LocalyzerReport.jpg

The Localyzer Icon LocalyzerIcon2.jpg opens up the Localyzer Report page. The Localyzer page has a number of icons on the left side for actions that can be done.

SendKitToTranslation.jpg Send kit to translation - send the latest prep kit to be translated at the specified Translation Management System or Machine Translation engine.

CheckImportIcon.jpg Check Import - Check the translation management system to see if translations are available to import. If previous translations passed the incoming checks but failed on pushing to the repository, Check Import will try again pushing to the repository those checked files.

DeactivateLastTranslationKitIcon.jpg Deactivate last translation kit - deactivate the last translation kit that was sent. A translation kit cannot be deactivated if any part of it has been imported.

ResetAllTranslationKitsIcon.jpg Reset all translation kits - this is used as a reset for the project.

CreateProjectBaselineIcon.jpg Create project baseline - Set the baseline so that the database can keep track of translation changes and imports. While creating and configuring the project, it does not have a baseline.

String Manager

Introduction video

Click on the image below to watch a String Manager introductory video:

String Manager Video.jpg

Overview

[Admin, Manager, Developer, Translator]

String Manager.jpg

String manager provides visibility into each key/value pair managed by Localyzer.

From the search box input text, find strings that match by their values, by their keys, by their filename. Filter strings that need to be sent, or have been sent and are not yet translated, or strings which are fully translated. Sort strings based on the text itself, the key, the filename, or the time it was found.

  • In the screen shot above, strings that match 'model' and are 'to be sent' are displayed.

Strings can be set 'to be reviewed', or 'reviewed', or neither. Certain strings will be marked 'to be reviewed' by the system. Filtering allows to select strings based on the status of the string.

A link for a specific resource points the browser to GitHub, GitLab or Bitbucket repository/project/branch/key-value pair. Typically, only developers will have access to their repositories and modify source strings.

Developers create and maintain the source strings, and if some strings need to be changed, only developers can change them. Users without access to the repository can copy the link and send it to the development team with some explanation, via Slack, Teams, Email, etc.

Localyzer makes changes to the target files with translations, pseudo-translation, context files, or LocalyzerQA type files. Developers should not modify those, especially outside of the branch where Localyzer pushed them, for fear of merge conflicts.

Issues

[Admin, Manager, Developer, Translator]

Issues.jpg

The Issues icon IssuesIcon.jpg opens the Issues page and will show all the Globalyzer and Localyzer issues. Once the issues page is open, the issues can be searched, filtered and sorted.

IssuesDetail.jpg

Selecting an issue in the list will show more detail about the issue, including its status, type and priority.

  • Go to line in source code - will take the user to the line of code in the repository, for users with repository access.
  • Learn more about this issue - will open up documentation about the issue.
  • Comments - any comments can be added about Globalyzer issues. They will remain after further analyses.

Project logs

[Admin, Manager, Developer, Translator]

ProjectLogs.jpg

The Console Logs icon LogsIcon.jpg opens up the logs to show when the project has been analyzed. Selecting any of the lines will open the log and show more detail.

ProjectLogDetail.jpg

In this example:

  • The user making the change is testAdmin
  • The version of Command Center is given
  • One setting in the General Settings was changed
    • Tags were modified on the project: FTP to FTP and Build 5

Edit Project configuration

[Admin, Manager]

EditProjectConfiguration.jpg

The Edit icon ConfigureIcon.jpg will open the Edit Project Configuration page. There are several icons on the left side of the page.

ValidateProjectIcon.jpg - validate the Localyzer configuration finds the resource files.

DuplicateProjectIcon.jpg - make a copy of this project

CleanProjectWorkspaceIcon.jpg - refresh the project

DeleteProjectIcon.jpg - remove the project from Command Center


General Settings

Data Source Settings

Access Settings

Globalyzer Settings

Localyzer Settings

Edit a project

There are multiple ways to get to edit a project.

EditProject1.jpg

First, from the Projects page, hover over the project and the Edit button will appear.


EditProject2.jpg

Second, select the project name (or the Globalyzer or Localyzer icon) to go to the Overview, Globalyzer or Localyzer page. Select the Configure button on the top to get to the Edit Project Configuration page.


EditProjectConfiguration.jpg

From this page, any of the settings can be changed.


When changes are made and saved, a notice appears at the top of the screen about the project being updated. The project does not run until it is manually run or by an automated task.

Retrieved from "http://wiki.lingoport.com/index.php?title=Individual_Project_Tasks&oldid=98889"