Difference between revisions of "Projects page"
(→Icons) |
(→Search Projects) |
||
| (22 intermediate revisions by 2 users not shown) | |||
| Line 7: | Line 7: | ||
Each project is summarized by a card. |
Each project is summarized by a card. |
||
| − | [[File:ProjectCard.jpg| |
+ | [[File:ProjectCard.jpg|800px|center]] |
== Icons == |
== Icons == |
||
| Line 13: | Line 13: | ||
The icons on the left of the indicate its state. |
The icons on the left of the indicate its state. |
||
| − | [[File: |
+ | [[File:ProjectStatus.NO_ERRORS.png|25px]] '''No errors''' - everything is good with the project and there are no issues. |
| − | [[File: |
+ | [[File:ProjectStatus.RUNNING.png|25px]] '''Running''' - This icon will rotate to indicate the the project is currently being analyzed |
| − | [[File: |
+ | [[File:In Queue.png|25px]] '''In Queue''' - The project is in the Task Queue. Projects are queued if the system is in Maintenance Mode or if many projects are being analyzed. The [[File:TaskQueueIcon.jpg|30px]] will indicate that there are jobs in the queue. |
| − | [[File: |
+ | [[File:ProjectStatus.RUN_FAILURE.png|25px]] '''Run Failure''' - This icon indicates that the the project has failed. It is accompanied by the |
| − | [[File:AnalysisFailedNotice.jpg| |
+ | [[File:AnalysisFailedNotice.jpg|120px]] Analysis Failed - This indicates that there is a problem with this project that should be explored. |
| − | [[File:ProjectStatus.DEVELOPER_ERRORS.png | |
+ | [[File:ProjectStatus.DEVELOPER_ERRORS.png |25px]] '''Developer errors''' - There are developer errors that will prevent translation. |
| − | [[File:ProjectStatus.LATE_TRANSLATIONS.png| |
+ | [[File:ProjectStatus.LATE_TRANSLATIONS.png|25px]] '''Late Translations''' - Translations are late returning from the translation management system |
| − | [[File:ProjectStatus.RUN_INTERRUPTED.png| |
+ | [[File:ProjectStatus.RUN_INTERRUPTED.png|25px]] '''Analysis was interrupted''' - The analysis was stopped for some reason |
| − | [[File:ProjectStatus.TRANSLATOR_ERRORS.png| |
+ | [[File:ProjectStatus.TRANSLATOR_ERRORS.png|25px]] '''Translator errors''' - Translations returned with errors. |
== Name == |
== Name == |
||
| − | [[File:ProjectCardName.jpg| |
+ | [[File:ProjectCardName.jpg|800px|center]] |
The project name in the card has several components. |
The project name in the card has several components. |
||
| Line 45: | Line 45: | ||
== Analysis Type == |
== Analysis Type == |
||
| − | [[File:ProjectCardAnalysis.jpg| |
+ | [[File:ProjectCardAnalysis.jpg|900px|center]] |
A project can by analyzed by Globalyzer and use Localyzer to manage locales and translations. |
A project can by analyzed by Globalyzer and use Localyzer to manage locales and translations. |
||
| − | [[File:GlobalyzerIcon.jpg| |
+ | [[File:GlobalyzerIcon.jpg|90px]] - The project is being analyzed by Globalyzer. Selecting this icon will open the Globalyzer Report page. |
| − | [[File:LocalyzerIcon.jpg| |
+ | [[File:LocalyzerIcon.jpg|90px]] - The project is using Localyzer and how much of the project has been translated. Selecting this icon will open the Localyzer Report page. |
== Analysis Status == |
== Analysis Status == |
||
| Line 58: | Line 58: | ||
The analysis section shows the current state of the project analyses and the last time it occurred. |
The analysis section shows the current state of the project analyses and the last time it occurred. |
||
| + | Selecting the analysis status will open the console logs for the last task performed on the project. |
||
| − | * Analysis Run |
||
| − | * Project Configuration changed |
||
| − | * Analysis Failed |
||
| − | |||
| − | Selecting the analysis status will open the console logs for the last analysis for the project. |
||
== Buttons == |
== Buttons == |
||
| Line 69: | Line 65: | ||
Only the Administrator and the Manager user will have access to the project card buttons. |
Only the Administrator and the Manager user will have access to the project card buttons. |
||
* The Run button will start the analysis of the project. |
* The Run button will start the analysis of the project. |
||
| − | ** The status icon will start twirling to indicate that it is processing |
+ | ** The status icon will change to the Running icon and start twirling to indicate that it is processing |
| − | ** Or the status icon will become the |
+ | ** Or the status icon will become the In Queue icon to indicate that the project is queued in the Task List to be analyzed. |
* The Edit button opens the Edit Project Configuration page for the project. |
* The Edit button opens the Edit Project Configuration page for the project. |
||
| Line 91: | Line 87: | ||
Search allows the user to look for projects that match a string. In the example, the word 'project' was matched with two projects with 'project' in the tags, project4 and project6. The search parameter is shown at the top of the screen. |
Search allows the user to look for projects that match a string. In the example, the word 'project' was matched with two projects with 'project' in the tags, project4 and project6. The search parameter is shown at the top of the screen. |
||
| + | |||
| + | Search can be run against different attributes of the projects: |
||
| + | * overall display name |
||
| + | * specific parts of the display names (group, project, module) |
||
| + | * tags |
||
| + | * locale names (for instance ''French'' or ''fr'') |
||
When the Search is closed, the search result remains and the search parameter is still shown. Selecting the search parameter and clearing it will return the full list. |
When the Search is closed, the search result remains and the search parameter is still shown. Selecting the search parameter and clearing it will return the full list. |
||
Latest revision as of 16:04, 2 October 2024
Contents
Introduction
Any user can select the 
to get to the Projects page. The view on the page will change depending on the user role.
Each project is summarized by a card.
Icons
The icons on the left of the indicate its state.
No errors - everything is good with the project and there are no issues.
Running - This icon will rotate to indicate the the project is currently being analyzed
In Queue - The project is in the Task Queue. Projects are queued if the system is in Maintenance Mode or if many projects are being analyzed. The 
will indicate that there are jobs in the queue.
Run Failure - This icon indicates that the the project has failed. It is accompanied by the
Analysis Failed - This indicates that there is a problem with this project that should be explored.
Developer errors - There are developer errors that will prevent translation.
Late Translations - Translations are late returning from the translation management system
Analysis was interrupted - The analysis was stopped for some reason
Translator errors - Translations returned with errors.
Name
The project name in the card has several components.
- Group Name - (CET) This is the name of the group for the projects. When creating a project, the group name defaults to the name of the repository
- Project Name - (CitySmart) The name of the project. This defaults to the name of the project in the repository at creation. The group name, project name and module combination must be unique.
- Module - (Quality) This can be the branch of the repository or another identifier.
- Tags - (newtag2, project4) Other identifiers for the project.
When the project name is selected from the Projects page, it opens the Project Overview.
Analysis Type
A project can by analyzed by Globalyzer and use Localyzer to manage locales and translations.
- The project is being analyzed by Globalyzer. Selecting this icon will open the Globalyzer Report page.
- The project is using Localyzer and how much of the project has been translated. Selecting this icon will open the Localyzer Report page.
Analysis Status
The analysis section shows the current state of the project analyses and the last time it occurred.
Selecting the analysis status will open the console logs for the last task performed on the project.
Buttons
Only the Administrator and the Manager user will have access to the project card buttons.
- The Run button will start the analysis of the project.
- The status icon will change to the Running icon and start twirling to indicate that it is processing
- Or the status icon will become the In Queue icon to indicate that the project is queued in the Task List to be analyzed.
- The Edit button opens the Edit Project Configuration page for the project.
Create and Configure Projects
[Administrator, Manager]
Only the Administrator and Manager users can create, edit or delete projects.
- Select the
to get to the Projects page. - Select the
. If the Manager does not have any Data Source Credentials assigned, the process will error. Contact the administrator to get credential access.
For detailed instructions on how to create a project:
Search Projects
[Admin, Manager, Developer, Translator]
Search allows the user to look for projects that match a string. In the example, the word 'project' was matched with two projects with 'project' in the tags, project4 and project6. The search parameter is shown at the top of the screen.
Search can be run against different attributes of the projects:
- overall display name
- specific parts of the display names (group, project, module)
- tags
- locale names (for instance French or fr)
When the Search is closed, the search result remains and the search parameter is still shown. Selecting the search parameter and clearing it will return the full list.
Filter Projects
[Admin, Manager, Developer, Translator]
Filter allows the user to filter the projects based on status, type or tag. In the example, the list is filtered by projects that have no errors, are Globalyzer projects, and have the tag 'project4' or 'QA'. The filter parameters are shown at the top of the screen.
When the Filter is closed, the result remains and the parameters are still shown. Selecting a parameter and clearing it will modify the filter. Filter and Search can be combined and both parameters show at the top of the window.
Sort Projects
[Admin, Manager, Developer, Translator]
Sort by allows the user to sort by the Group name or the Project name in ascending or descending order. The sort remains when the Sort is closed.
