Pontoon: move search and filter content to workspace page (#249)

Author: flodolo

.github/workflows/deploy.yaml

@@ -13,7 +13,7 @@ jobs:
   fetch:
     runs-on: ubuntu-latest
     env:
-      MDBOOK_VERSION: v0.4.36
+      MDBOOK_VERSION: v0.4.40
       MDBOOKTOC_VERSION: 0.14.2
     steps:
       - name: Clone repository

book.toml

@@ -13,4 +13,6 @@ edit-url-template = "https://github.com/mozilla-l10n/localizer-documentation/edi
 no-section-label = true
 
 [output.html.redirect]
+"/tools/pontoon/search_filters.html" = "/tools/pontoon/translation_workspace.html#search"
+"/tools/pontoon/ui.html" = "/tools/pontoon/translation_workspace.html"
 "/tools/pontoon/workflow.html" = "/tools/pontoon/translate.html#workflow-example"

src/SUMMARY.md

@@ -25,8 +25,7 @@
 * [Tools](README.md)
     * [Pontoon](tools/pontoon/README.md)
         * [How to translate](tools/pontoon/translate.md)
-        * [Translation workspace](tools/pontoon/ui.md)
-        * [Search and filters](tools/pontoon/search_filters.md)
+        * [Translation workspace](tools/pontoon/translation_workspace.md)
         * [Team and project pages](tools/pontoon/teams_projects.md)
         * [User accounts and settings](tools/pontoon/users.md)
         * [Notifications](tools/pontoon/notifications.md)

src/assets/images/pontoon/ui/concordance_search.png src/assets/images/pontoon/translation_workspace/concordance_search.png

@@ -8,14 +8,14 @@ Note: These instructions apply only to projects that make use of Bugzilla, which
 
 The first step is to identify where the string is within the Mercurial repository by using [Searchfox](https://searchfox.org/).
 
-For example, if you want to know which bug introduced the string `Password quality meter`, you can search for the [string](https://searchfox.org/mozilla-central/search?q=Password+quality+meter&path=&case=false&regexp=false). This may return multiples strings with the same text, so to find the exact string you can use the the [identifier](https://searchfox.org/mozilla-central/search?q=password-quality-meter&path=&case=false&regexp=false) (which can be found from [CONTEXT](../pontoon/ui.md#context) in Pontoon).
+For example, if you want to know which bug introduced the string `Password quality meter`, you can search for the [string](https://searchfox.org/mozilla-central/search?q=Password+quality+meter&path=&case=false&regexp=false). This may return multiples strings with the same text, so to find the exact string you can use the the [identifier](https://searchfox.org/mozilla-central/search?q=password-quality-meter&path=&case=false&regexp=false) (which can be found from [CONTEXT](../pontoon/translation_workspace.md#context) in Pontoon).
 
 The results may look something like this:
 
 ![Searchfox](../../assets/images/mercurial/searchfox.png)
 
 You can further refine results to only localization files by using specific localization file extensions in the `Path filter` field in the top right:
-* For Firefox: limit the search to `.ftl` or `.properties` files. You can find information on the file from its [CONTEXT](../pontoon/ui.md#context). Or you can use `{.ftl,.properties}` to only show files with those extensions.
+* For Firefox: limit the search to `.ftl` or `.properties` files. You can find information on the file from its [CONTEXT](../pontoon/translation_workspace.md#context). Or you can use `{.ftl,.properties}` to only show files with those extensions.
 * For Android: limit the search to `.xml` files.
 
 ![Searchfox](../../assets/images/mercurial/searchfox-path.png)

src/assets/images/pontoon/ui/context.png src/assets/images/pontoon/translation_workspace/context.png

@@ -5,8 +5,7 @@ This document covers how to work with [Pontoon](https://pontoon.mozilla.org/) fr
 If you’re interested in administrating Pontoon, please read [these documents](https://mozilla-l10n.github.io/documentation/tools/pontoon/index.html).
 
 * [How to translate](translate.md).
-* [Translation workspace](ui.md).
-* [Search and filters](search_filters.md).
+* [Translation workspace](translation_workspace.md).
 * [Team and project pages](teams_projects.md).
 * [User accounts and settings](users.md).
 * [Notifications](notifications.md).

src/assets/images/pontoon/ui/editing_space_ftl.png src/assets/images/pontoon/translation_workspace/editing_space_ftl.png

@@ -10,7 +10,7 @@ Comments can be used, for example, to discuss possible translations with other t
 
 Pontoon supports two types of user comments:
 * *Source string comments* are associated with the source string and displayed in the `COMMENTS` tab in the right column.
-* *Translation comments* are associated with a specific translation and displayed under the editor in the [translation list](ui.md#translation-list).
+* *Translation comments* are associated with a specific translation and displayed under the editor in the [translation list](translation_workspace.md#translation-list).
 
 User comments should not be confused with *Resource comments*, which developers can add directly to the resource file. This type of comment is displayed in the editing area, along with other information like the [resource path and context](#resource).
 

src/assets/images/pontoon/ui/editing_space_ftl_plurals.png src/assets/images/pontoon/translation_workspace/editing_space_ftl_plurals.png

@@ -97,7 +97,7 @@ It also includes an indication of the overall status of completion and statistic
 There are up to 5 tabs available to all [roles](users.md#user-roles), and 1 additional tab for those with Administrator roles:
 
 * **Teams**: a list of all locales enabled in Pontoon for this project.
-* **Tags**: a list of tags defined for this project. This tab will be visible only in projects where tags are enabled. For more information about tags, see [this page](search_filters.md#tags).
+* **Tags**: a list of tags defined for this project. This tab will be visible only in projects where tags are enabled. For more information about tags, see [this page]translation_workspace.md#tags).
 * **Contributors**: a list of active contributors with their statistics, filterable by time (all time, last 12/6/3/1 months).
 * [**Insights**](#insights-graphs): contains data and trends presented in a graphical format about review activity and translation activity.
 * **Info**: information about this project.
@@ -125,7 +125,7 @@ The page header contains useful information about the current project (same as t
 
 There are 6 tabs available:
 * **Resources**: files available in the project.
-* **Tags**: a list of tags defined for this project. This tab will be visible only in projects where tags are enabled. For more information about tags, see [this page](search_filters.md#tags).
+* **Tags**: a list of tags defined for this project. This tab will be visible only in projects where tags are enabled. For more information about tags, see [this page](translation_workspace.md#tags).
 * **Contributors**: a list of active contributors with their statistics, filterable by time. Unlike the tab available in the Team page, this only includes contributions to localization of the project for the current locale.
 * [**Insights**](#insights-graphs): contains data and trends presented in a graphical format about review activity and translation activity.
 * **Project info**: information about the project.
@@ -139,7 +139,7 @@ The Insights tab, accessible from either the Project, Team, or Localization page
 
 The following insights appear on all pages:
 * **Review activity**: shows the number of unreviewed suggestions as a trend line. The Team page also shows the number of peer-approved, self-approved, and rejected suggestions for each month as a bar graph to display the impact of the review process on the number of unreviewed suggestions. New suggestions (hidden by default) can also be shown by clicking `New suggestions` at the bottom of the graph. Hover over a data point to get the detailed number of strings and percentages for that month.
-* **Translation activity**: shows the translation completion percentage for the locale as a trend line. The Team page also shows the number of human translations and [machinery translations](ui.md#machinery) for each month as a bar graph to display the impact of the translation process on the number of completed translations. New source strings (hidden by default) can also be shown by clicking `New source strings` at the bottom of the graph. Hover over a data point to get the detailed number of strings and percentages for that month.
+* **Translation activity**: shows the translation completion percentage for the locale as a trend line. The Team page also shows the number of human translations and [machinery translations](translation_workspace.md#machinery) for each month as a bar graph to display the impact of the translation process on the number of completed translations. New source strings (hidden by default) can also be shown by clicking `New source strings` at the bottom of the graph. Hover over a data point to get the detailed number of strings and percentages for that month.
 
 The following insights only appear on Team pages:
 * **Active users**: shows the ratio of active versus total for each [user role](users.md#user-roles): managers (Team managers), reviewers (Team managers and Translators), and contributors, filterable by time period (last 12/6/3/1 months).

src/assets/images/pontoon/ui/editing_space_ftl_sourceview.png src/assets/images/pontoon/translation_workspace/editing_space_ftl_sourceview.png

@@ -1,6 +1,6 @@
 # How to translate
 
-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).
+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](translation_workspace.md), including [translation tools](translation_workspace.md#translation-tools-and-comments).
 
 ## Translating strings
 
@@ -31,7 +31,7 @@ To switch back to *Translation Mode*, click the settings icon again and turn off
 
 ## Reviewing strings
 
-To review a suggestion or pretranslation, [search](search_filters.md) for unreviewed or pretranslated strings in the sidebar.
+To review a suggestion or pretranslation, [search](translation_workspace.md#search) for unreviewed or pretranslated strings in the sidebar.
 
 If the current translation is acceptable, either click on the `APPROVE` button in the lower-right side of the editing space, or click on the approve icon to the right of the text. This will transform the suggestion or pretranslation into an approved translation. In the case of suggestions, the approved translation will also be stored in the version control system (where applicable).
 
@@ -122,13 +122,13 @@ This workflow utilizes the full power of Pontoon’s online translation features
 
 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.
+3. Using [filters](translation_workspace.md#search) 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).
+    * If something is unclear or there is a question about the source string, use the [REQUEST CONTEXT or REPORT ISSUE](translation_workspace.md#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.
+* Rely on Pontoon’s [translation tools](translation_workspace.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
@@ -137,7 +137,7 @@ General notes:
 
 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.
+3. In [filters](translation_workspace.md#search) 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).