Documentation

This repository includes several documents describing how to perform internal tasks within the l10n-drivers team at Mozilla. If you’re reading these pages on GitHub, a version with improved readability and search capabilities is available here.

Topics covered:

• Manage Firefox for Android and Firefox desktop: setting up builds, bootstrap productization settings, and testing.
• How to review strings and perform sign-offs for Firefox desktop and Firefox for Android.
• Manage App Store and Google Play content updates.
• Manage mozilla.org localization.
• Technical documentation and common tasks for our webdashboards.
• Technical documentation for the Stores web app.
• Perform common and advanced tasks on Pontoon like adding new locale, and creating a new project.
• Other miscellaneous documents related to localization tasks.

How to read these documents

You will need a Unix-like environment (Linux, macOS) to run most of the tools. Across the entire documentation, commands to run in a terminal are described like this:

$ composer update

$ is not part of the command, it just indicates the terminal prompt. The command to type or copy and paste is simply composer update.

In several occasions documents use aliases instead of the complete path to commands: for example lang_update instead of path_to_langchecker_clone/app/scripts/lang_update. Check Setting up a Linux Virtual Machine for Webdashboards for instructions on how to setup a virtual machine running on Linux Ubuntu with all the necessary packages and aliases.

Updating the documentation

Simply open a pull request adding the new file or updating an existing document. Make sure to follow these style guidelines, and note that all pull requests need to be reviewed before merging.

You can run the following commands to make sure that files are correctly formatted (you will need to install npm if it’s not already available):

$ npm install
$ npm test

GitBook

GitBook is built automatically via Travis, and changes pushed to the gh-pages branch. If you want to build and preview the GitBook locally, install npm and and run the following commands from the root of the repository:

$ npm install
$ npm start

If you want content to appear on Gitbook, it needs to be listed in SUMMARY.md.