From e461e221550f313bb497878b513c81f1d9725f88 Mon Sep 17 00:00:00 2001 From: Kazephil Date: Sun, 20 Aug 2023 22:10:54 +0900 Subject: [PATCH] Update sections on team projects --- doc_src/en/HowTo_SetUpTeamProject.xml | 69 +++++++++++++++++++++------ doc_src/en/HowTo_UseTeamProject.xml | 17 +++---- 2 files changed, 64 insertions(+), 22 deletions(-) diff --git a/doc_src/en/HowTo_SetUpTeamProject.xml b/doc_src/en/HowTo_SetUpTeamProject.xml index 5a9778ee12..3abaaf7ae8 100644 --- a/doc_src/en/HowTo_SetUpTeamProject.xml +++ b/doc_src/en/HowTo_SetUpTeamProject.xml @@ -50,8 +50,9 @@ The local repository is used to add the initial project to the - server, and can also be used for maintenance tasks, such as deleting - files, that cannot be performed directly within OmegaT. + server, as well as for certain maintenance tasks. See the + section for details. We recommend that you avoid using that folder for translation tasks. If you need to perform translation or review tasks on that project, use OmegaT to download a separate copy of the team project and @@ -102,7 +103,7 @@ to the repository. Use to add files + endterm="menus.project.commit.source.files.title"/> to add source files from OmegaT. You must use your SVN or Git client, or the command line, to @@ -127,7 +128,7 @@ linkend="menus.project.commit.target.files" endterm="menus.project.commit.target.files.title"/>. - The team project administrator must use the local VCS to + The team project manager must use the local VCS to modify or delete those files. Some plugins can make this task easier. See the After the project is ready and has been uploaded to the server, - the team project administrator has to set up access for the translators. + the team project manager has to set up access for the translators. Accessing a team project requires the following information: @@ -173,9 +174,9 @@ The translators will have to create an account for the service, and send their user name to the team project - administrator. + manager. - The administrator will then grant write access to the + The manager will then grant write access to the repository to those accounts. @@ -184,10 +185,10 @@ If the server is self-hosted and does not have a provision for translators to register an account themselves, the team project - administrator must create accounts with write access for the + manager must create accounts with write access for the translators. - After creating the accounts, the administrator must send the + After creating the accounts, the project manager must send the translators their individual credentials. @@ -197,7 +198,7 @@ Have everybody download the project from OmegaT - Administrators have two options for sending the location of the + Project managers have two options for sending the location of the project to the translators: @@ -219,10 +220,10 @@ - After the team project administrator confirms that a translator + After the team project manager confirms that a translator has been able to open the team project, it is a good idea to make sure that the project - statistics are the same for both the administrator (on the + statistics are the same for both the project manager (on the server) and the translator (locally). If they do not match, make sure the @@ -243,6 +244,46 @@ +
+ Manage a team project + + Team projects involve a number of management tasks not directly related + to translation. Project managers may find it advantageous—or even necessary—to + handle such tasks directly from the VCS repository, particularly in cases where + the project manager only acts as a coordinator and is not involved in the translation + process itself. + + + Deleting files + + OmegaT does not provide a mechanism to delete files from a team project. + If any shared team project files have become unnecessary, the project manager + must delete them from the VCS repository. + + + + Adding files + + Although OmegaT provides a mechanism for adding translation source and + target files to the repository, the project manager must add any other files, + such as dictionaries, glossaries or reference translation memories, from the + VCS repository. + + + + Checking project statistics + + This only applies to workflows that ask translators to commit the translated + target files to the repository as deliverables. + When OmegaT commits the target files, it also commits the project statistics + in .txt and .json format. This enable the + project manager to consult the statistics, and possibly automate their processing, + without the need to open OmegaT. + + + +
+
Repository mappings @@ -405,7 +446,7 @@ sharing The above process describes the most common scenario, in which the - team project administrator has full control of the project and all files + team project manager has full control of the project and all files (and statistics) are identical in all instances of the project, both on the server and the local systems of the translators. @@ -414,7 +455,7 @@ subset of the other files. The basic procedure is essentially the same, except that the team - project administrator does not add every file to the version-controlled + project manager does not add every file to the version-controlled project on the server. The remaining files are either copied by the translators themselves, or mappings that synchronize files from other locations are defined. diff --git a/doc_src/en/HowTo_UseTeamProject.xml b/doc_src/en/HowTo_UseTeamProject.xml index 14a684e2df..2f84c6ffca 100644 --- a/doc_src/en/HowTo_UseTeamProject.xml +++ b/doc_src/en/HowTo_UseTeamProject.xml @@ -6,7 +6,7 @@ Team projects use synchronization mechanisms between project members. - Once a OmegaT team project is installed on a server, the administrator + Once a OmegaT team project is installed on a server, the project manager sends members the information they need to access it: a URL indicating the location of the project, or an omegat.project file. @@ -46,11 +46,11 @@ linkend="menus.project.download.team.project"/> to bring up the Download Team Project dialog. - Enter the URL provided by the team project administrator in the + Enter the URL provided by the team project manager in the Repository URL: field at the top of the dialog, and specify a folder for the project in the New Local Project Folder: field. Leave the Default - branch option checked unless the project administrator + branch option checked unless the project manager has provided instructions for using a custom branch. @@ -141,7 +141,7 @@ In a team project, the basic configuration parameters of the local project are always overridden by the configuration on the - server originally set by the project administrator. + server originally set by the project manager. @@ -179,7 +179,7 @@ If you first download the remote project using an omegat.project file provided by the project - administrator, OmegaT will use the mappings in that file, if + manager, OmegaT will use the mappings in that file, if any. @@ -208,7 +208,7 @@ - Only the project administrator should use Only the project manager should use . @@ -225,7 +225,8 @@ linkend="menus.project"/> to add them to the - server, if the project administrator has requested you to do so. + server, if the project manager has requested you to do so. + Committing the target files also uploads the statistics files to the server. @@ -236,7 +237,7 @@ Files in a team project cannot be deleted from OmegaT or the local file system. They will be restored the next time the project is synchronized. This task is normally performed by the project - administrator. + manager.