Giter VIP home page Giter VIP logo

documentation's Introduction

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:

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.

GitBook

GitBook is built automatically via Travis, and changes pushed to the gh-pages branch.

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

documentation's People

Contributors

delphine avatar flodolo avatar guerojeff avatar mathjazz avatar peiying2 avatar theochevalier avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.