Use case #2: Set up a Weblate instance and project

[lecoqlibre]

Description

The WP administrator sets up a Weblate instance and a project to use for translating the website. To do so, a WP instance and a WP project are created. They point to the Weblate instance and project (like an image or a local copy). This use case is usually executed one time and it should be done before translating WP objects.

Postconditions

Success guarantees

• a new WP instance is created with a name, an API base URI and a token:
  • it is associated with the Weblate instance
• a new WP project is created:
  • it is associated with the Weblate project
  • it is associated with the WP instance previously created

Preconditions

• Scope: WP admin area
• Actor: WP administrator
• Weblate: an instance with at least a project with access granted

Scenario

1. add a new WP instance
2. set the title of the instance and provide a API base URI to fetch data from (eg. https://hosted.weblate.org/api/)
3. provide a token and validate: this fetch the Weblate projects from the Weblate API
4. select the project to use for translating in the previous list
5. save the instance
6. a notice indicates that a WP project has been created

Extensions

• 3a. If the API can't be reached or the token is invalid, show an error and repeat this step until these settings are valid.
• 3aa. If this step is ignored, go to step 5. The WP project is not created now but should be created later. Don't do the step 6.
• 4a. If no project is fetched from the API, go to step 5. The WP project will not be created. Don't do the step 6.
• 4aa. Multiple projects can be selected at once. Each of them will be created. The notice at step 6 indicates a list of created projects.