Pontoon: move workflow content in how to translate (#248)

* Pontoon: move workflow content in how to translate

Author: flodolo

book.toml

@@ -11,3 +11,6 @@ renderer = ["html"]
 git-repository-url = "https://github.com/mozilla-l10n/localizer-documentation/"
 edit-url-template = "https://github.com/mozilla-l10n/localizer-documentation/edit/main/{path}"
 no-section-label = true
+
+[output.html.redirect]
+"/tools/pontoon/workflow.html" = "/tools/pontoon/translate.html#workflow-example"

src/SUMMARY.md

@@ -31,7 +31,6 @@
         * [User accounts and settings](tools/pontoon/users.md)
         * [Notifications](tools/pontoon/notifications.md)
         * [Profile page](tools/pontoon/profile.md)
-        * [Example workflow](tools/pontoon/workflow.md)
         * [Glossary](tools/pontoon/glossary.md)
     * [Fluent](tools/fluent/README.md)
         * [Fluent syntax](tools/fluent/basic_syntax.md)

src/tools/pontoon/README.md

@@ -11,7 +11,6 @@ If you’re interested in administrating Pontoon, please read [these documents](
 * [User accounts and settings](users.md).
 * [Notifications](notifications.md).
 * [Profile page](profile.md).
-* [Example workflow](workflow.md).
 * [Glossary](glossary.md).
 
 **Note:** The screenshots in this documentation use the dark theme, but a light theme is also available.

src/tools/pontoon/translate.md

@@ -1,6 +1,6 @@
 # How to translate
 
-This document describes briefly how to translate and review strings in Pontoon. The documentation also includes a dedicated page about Pontoon’s [translation workspace](ui.md), including [translation tools](ui.md#translation-tools-and-comments).
+This document describes briefly how to translate and review strings in Pontoon and provides an [example of translation workflow within a team](#workflow-example). The documentation also includes a dedicated page about Pontoon’s [translation workspace](ui.md), including [translation tools](ui.md#translation-tools-and-comments).
 
 ## Translating strings
 
@@ -111,3 +111,49 @@ Here’s an example command to download German (de) .tbx file in the `TBX 2008 (
 ```
 curl -o de.v2.tbx --compressed https://pontoon.mozilla.org/terminology/de.v2.tbx
 ```
+
+## Workflow example
+
+This workflow utilizes the full power of Pontoon’s online translation features. It assumes that at least two translators are available for the project (*AB workflow*); however, this workflow can be completed by a single translator performing each phase (*AA workflow*), or by multiple translators in an *ABC<sub>n</sub> workflow* repeating Phase 3.
+
+### Phase 1: translation
+
+#### Translator A
+
+1. Log in to Pontoon.
+2. Browse to the [project](teams_projects.md).
+3. Using [filters](search_filters.md) select `Missing` to display only the strings currently missing a translation, marked as [fuzzy](glossary.md#fuzzy) or containing errors.
+4. Access personal settings by clicking on the gear icon below the editing field and turn on `Make suggestions`.<br>Note that new contributors who have not yet been granted [Translator permissions](users.md#user-roles) will only have the ability to `Make suggestions`, which will be enabled by default.
+5. For each string, type a translation and save it with the blue `SUGGEST` button. The string will be stored and displayed under the editor. Each translation submitted shows the name of the author and when it was saved.
+    * If something is unclear or there is a question about the source string, use the [REQUEST CONTEXT or REPORT ISSUE](ui.html#source-string) feature to ask the [Project manager](users.md#user-roles).
+
+General notes:
+* Rely on Pontoon’s [translation tools](ui.md/#translation-tools-and-comments) to ensure consistency and make the translation process faster.
+* When using Firefox, make sure to have a [dictionary](https://addons.mozilla.org/firefox/dictionaries/) installed for the translation language, and that spell checking is enabled in the translation text area.
+
+### Phase 2: review suggestions
+
+#### Translator B
+
+1. Log in to Pontoon.
+2. Browse to the [project](teams_projects.md).
+3. In [filters](search_filters.md) select `Unreviewed`, to isolate the strings previously suggested by another translator.
+4. Review the suggested strings.
+     * If a suggestion is acceptable:
+        * Confirm it as an approved translation by clicking the green `SAVE` button or the checkmark icon near the string in the list below the editor (it turns green when hovered).
+     * If a suggestion is not acceptable:
+        * Switch to [Suggest mode](translate.md). Edit the translation in the editing space and click the blue `SUGGEST` button. The newly suggested version will **not** overwrite the translator’s work, but instead will appear at the top of the list under the editor.
+     * Use [translation comments](glossary.md#comment) to discuss a translation with the other translator. For example, discussing possible alternate translations or asking questions when something isn’t clear.
+
+### Phase 3: implementing QA
+
+#### Translator A
+
+1. In the project, select `Unreviewed` from the filter search. Then compare the initial entries with those of the reviewer for changes.
+2. Review the remaining strings:
+    * If in agreement, confirm the reviewer’s version by clicking the green `SAVE` button or the checkmark icon near the string in the list below the editor (it turns green when hovered).
+    * If suggesting an alternative, type it into the editor, then hit the blue `SUGGEST` button. Then resubmit it to the reviewer from Phase 2.
+    * Reject suggestions not considered suitable by clicking on the cross icon near the string (it turns red when hovered).
+    * If Translator A does not have the Translator or Team manager role, they will be unable to confirm or reject a suggestion. In that case, use [translation comments](glossary.md#comment) to discuss the translation with the reviewer.
+
+Repeat, switching translators, until a consensus is reached.