Use case #4: Update the website's content with the translations hosted in Weblate

[lecoqlibre]

Description

The WP administrator updates the website's content with the new translations hosted on the Weblate instance. This use case is used every time new translations need to be installed onto the website. Updates can be made on various WP objects, including the instances, projects or components used with Weblate. When an update occurs on an object, a update job is scheduled until the object is loaded.

Postconditions

Minimal guarantees

• update jobs are planned

Success guarantees

• new translations are installed onto the concerned WP objects (when planned jobs are executed)

Preconditions

• Scope: WP admin area
• Actor: WP administrator

Scenario

1. select the WP instance(s) to be updated
2. trigger the update
3. a page shows a recap of all the translations that can be updated
4. the administrator selects the translation updates he/she wants to install onto the website
5. the administrator validates the process
6. every selected update is planned as a job. The translation status of the concerned WP objects is set as "scheduled". When the concerned WP object loads, the translation is updated and the "scheduled" translation status is removed.
7. go back to the page of step 1. A notice shows the number of planned jobs and indicates that the update is successful.

Extensions

• 1a. WP project(s) can be selected in place
• 1b. WP component(s) can be selected in place
• 1c. WP object(s) can be selected in place
• 4a. If no translation update is selected, update is canceled, go to step 7, the notice indicates that no translation is planned.
• 5a. If the administrator does not validate the process, update is canceled, go to step 7, the notice indicates that no translation is planned.

[nijel]

Shouldn't updates happen automatically in the background?

[lecoqlibre]

I haven't consider this automatic update thinking that the translations would be checked by the WP admin before they are merged into the website. Do you think about an auto update based on the age of changes, in hours for example like in a Weblate component? Do you think the manual updates can be useful or we just should provide the automatic updates only?

[nijel]

In many cases site admin will not know the languages, so the approval would be purely formal. But this is similar to using pull requests for repository translations versus direct pushing. Some people prefer pull requests, but most use direct push as actual review of the translations already happens in Weblate.