Skip to content
This repository has been archived by the owner on Feb 5, 2023. It is now read-only.

Home

Jump to bottom
Robert-Jan edited this page Aug 4, 2020 · 15 revisions

Motivation

There are currently 70+ teams that translate Raspberry Pi Foundation content into different languages. On the other hand there are only 2 people at the Foundation that can publish those translations.

This naturally introduces a bottleneck in the entire process. That's why the idea of this project is to remove as much manual steps as possible from the publishers' plate and/or provide ability for the teams to do publishing themselves.

This document contains description of the steps needed for publishing of translations.

This document lists the current issues that should be addressed.

The issues were transformed to GitHub issues which can be found here. Issue tracking can be found on the following board.

Wiki Index

  1. Publishing Q&A
  2. Miscellaneous Issues
  3. Publishing Workflow

Developer Guide

Source Code Organization

This repository contains source code that was originally published at in this repository. Hopefully once we are done with the improvements the code will be ported back into the "parent" repo.

The repo has 3 main branches:

  • master -> The latest version 0.2.1 of nttt tool that according to Nina is broken. We are not going to touch the branch. It’s there just for the ease of upcoming migration to the proper place

  • stable -> The currently used version 0.1.0. Until we’re done with all the improvements (or some meaningful part of them) this branch will stay intact. It’s needed as a pointer to our starting point and a quick way to revert in case something gets broken

  • improvements -> This is the branch we’re going to implement our changes in. After those are implemented and tested we will merge it to the stable branch.

Working on Issues

  • Pick an issue from the repo's board.
  • Create a separate feature branch and implement your changes there, including unit tests.
  • Create pull request (PR) from the feature branch to improvements and ask someone from the team to review and to merge it. Remove the feature branch that is no longer needed once the proposed changes have been merged.

Running the Unit Tests

In the root of the repository, run the following command: python -m unittest discover -s unit_test/ -v (replace python with python3, if necessary). This works on Windows, Linux and macOS.

Clone this wiki locally