This repository includes several documents describing topics of interest for localizers at Mozilla. If you’re reading these pages on GitHub, a version with improved readability and search capabilities is available here.
We use GitHub issues to track missing documentation and updates to existing pages.
In order to contribute, open a pull request in the repository, 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 merge.
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
To generate these pages, mdBook is used and built automatically via GitHub Actions, and changes pushed to the gh-pages branch. If you want to build and preview the pages locally, install Rust and cargo and then run the following commands from the root of the repository:
$ cargo install mdbook
$ cargo install mdbook-toc
$ mdbook serve
mdbook-toc is used as a preprocessor, and will install the correct version of mdBook as a dependency.
If you want a new page to be available in GitHub pages, make sure to include a link in src/SUMMARY.md.