Messages-Review.asciidoc

This is about Bug 953734 - RFE: Implement review feature, that is, the user with review role can approve or rejected translation messages.

1. Test Basis

• Only translator role can edit the translation message and change the state to Untranslated, Fuzzy, Translated.

• Only reviewer role can Approve or Reject a non empty translation message.

• Project maintainers has both translator and reviewer role.

1.1. How to Appoint or Dismiss a reviewer role

• Only a Language Coordinator can appoint or dismiss a reviewer role for that language.

• A reviewer can be appointed or dismissed in the Team member management view.

1.2. How to Enable or Disable Review for a Project Version

• Only a Project Maintainer can enable or disable the review feature.

• The review feature can be enabled or disabled in Project Version Editing View.

• The default is disable.

1.2.1. On disabling review feature, what happened to existing approved and rejected messages?

• Cannot approve messages.

• Existing approved messages stays approved.

• Cannot reject messages.

• Existing rejected messages stays rejected.

• Approved messages are treated as Translated.

  • Approved messages are Pulled as Translated.

  • Approved messages are Downloaded as Translated.

  • Approved messages in ZIP are Downloaded as Translated.

• Rejected messages are treated as Fuzzy.

  • Rejected messages are pulled as Fuzzy.

  • Rejected messages are downloaded as Fuzzy.

  • Rejected messages in ZIP are downloaded as Fuzzy.

1.3. Completed and Incomplete Translation

• Completed is defined as either

  • Approved+Translated, if review is enabled, or

  • Translated, if review is disabled

• Incomplete is defined as either:

  • Rejected+Fuzzy+Untranslated, if review is enabled

  • Fuzzy+Untranslated, if review is disabled,

1.4. Statistic Views

1.4.1. Project Version View

• A column Statistic shows and each language team has its own progress bar.

  • Progress bar shows percent completed, defined as Completed/Total

  • Tool tip of the progress bar shows a table contains the states and corresponding counts.

    • If review is enabled, a table contains 5 states (Approved, Translated, Rejected, Fuzzy and Untranslated) and their counts are shown.

    • If review is disabled, a table contains 3 states (Translated, Fuzzy and Untranslated) and their counts are shown.

1.4.2. Document List View

• A column Statistic shows and each document has its own progress bar.

  • Progress bar shows percent completed, defined as Completed/Total

  • Tool tip of the progress bar shows a table contains the states and corresponding counts.

    • If review is enabled, a table contains 5 states (Approved, Translated, Rejected, Fuzzy and Untranslated) and their counts are shown.

    • If review is disabled, a table contains 3 states (Translated, Fuzzy and Untranslated) and their counts are shown.

• A column Complete shows and each document has its own the count of Completed.

• A column Incomplete shows and each document has its owns the count of Incomplete.

1.5. Translation Editing View

1.5.1. Filtering

• User can toggle the filter Completed.

  • User can toggle the sub-filter Approved.

  • User can toggle the sub-filter Translated.

• User can toggle the filter Incomplete.

  • User can toggle the sub-filter Approved.

  • User can toggle the sub-filter Translated.

• After filters toggled, the search results are updated as:

  • Union of checked filters, if at least one filter is checked.

  • All translated messages, if none of the filters are checked.

1.5.2. Active Row

• Translator actions: Clear translation message, Change translation messages, Copy Source Messages, Save as Fuzzy and Save as Translated.

  • Only translator role can perform translator actions.

• Reviewer actions: Save as Approved and Save as Rejected

  • Only Reviewer role can perform review actions.

  • Review actions are only activated when Review Feature is enabled.

1.6. Client

1.6.1. Push and Upload

• Only project maintainers can push/upload source files.

• Only translator role can push/upload translation files.

• With merge=auto, Decision Table on Push defines the behavior of whether server translation string and state should be updated.

1.6.2. Pull and Download

• Only user role can pull/download source files.

• Only translator role can push/upload translation files.

• Decision Table on Pull as File Format That Support Fuzzy defines the behavior when outputting to a file format that support fuzzy.

• Decision Table on Pull as File Format That Does Not Support Fuzzy defines the behavior when outputting to a file format that does not support fuzzy.

1.7. Data migration from Zanata version prior 3.0.0 (Exclusive)

• Existing projects do not enable review feature by default.

• Existing users do not get the reviewer role by default.

2. Features Not in the Releases (Not to be tested)

• Push/Upload options For the use cases where the Decision Table on Push is not suitable.

• Pull/Download options For the use cases where the Decision Table on Pull as File Format That Support Fuzzy and Decision Table on Pull as File Format That Does Not Support Fuzzy are not suitable.

3. Decision Tables

• Decision Table on Push

• Decision Table on Pull as File Format That Support Fuzzy

• Decision Table on Pull as File Format That Does Not Support Fuzzy

• Decision Table on Copy Trans

• Decision Table on Translation Memory