We welcome our community to get involved with contributing to our microbit.org translation project. This page gives an overview of how to get involved along with translation tips.
How to get involved
The microbit.org multi-lingual project is hosted on the easy-to-use Crowdin platform here:
You can find a list of existing language projects, if you’re a native speaker and would like to help, simply sign up and click the “Join Translation Project” button. We recommend you have at least a couple hours a week to keep involved with maintaining a language. It is a fun and rewarding to help out with micro:bit. And you’re sure to know everything first :-)
Are you interested to add a new language not yet supported? Translating a new language usually takes several days of work and a few rounds of proof-reading and is best with 2-3 people involved. If you are interested please contact us on the Crowdin project.
Keep in mind that most of the site is meant for 8-19 year old non-technical users of micro:bit, so we want to keep a fun and non-intimidating style of language.
The Teach and Education pages are aimed at teachers and other education professionals.
The translation process
Please use direct messages (Contact link) and Discussions to ask questions or coordinate with other translators. You can also leave comments attached to a string, for example when unsure about a translation or to explain something for other translators.
- A microbit.org contributor adds new content (that’s done in Github)
- A translator suggests a translation to each string of the new content using the online editor.
- Periodically micro:bit will post a test version of the website with all latest translations at http://stage.microbit.org
- A proofreader for the language will check and approve translated strings
- We post live versions of http://microbit.org 1-2 times a week including the latest translation updates.
What to translate
The microbit.org webpage is made up of the following parts, see detailed instructions below:
- Tags - These are single words or sentences used in the header, footer or home page of the site.
- Pages - These are static pages (e.g. /about) with more text content.
- Posts - These are more dynamic articles, news, tutorials, lessons etc. These are shown on the home page, Ideas page or Teach page depending on how it is tagged.
A minimum translation must have the Tags and Pages completed. For Posts the title and description can be translated and optionally the content where it makes common sense.
Pages in English only
Some pages are left mostly in English only to make website maintenance easier such as:
- Our Team
The translation tags are located in the /_data/ directory.
Simply translate the each of the strings.
Pages are located in the /en/ directory.
Translate only the title:, heading: and description: strings at the top of each file. Do not change the other entries or the — lines.
Translate the HTML visible text strings (not links) that follows.
Posts are located in the /_posts/en/ directory.
Translate the title: and description: strings at the top of each file. Do not change the other entries or the — lines.
If there is content after this section, you may optionally translate the content. Most posts are links to external articles, and won’t have content.
Not all posts will make sense to translate into a local language, some posts might e.g. be relevant only in the UK or US in English. For example if a post is an external link and the content is in English - it makes sense to leave the title in English.
Previewing your translation
For languages which are live we provide in-context localisation environment at: http://preview-translate.microbit.org/. This allows you to preview your changes on the site as you’re making them.
Contributing to microbit.org
New posts can separately be contributed by submitting a simple HTML file with the header fields and possible content, along with a 512x288px image for the post to firstname.lastname@example.org.
For change suggestions to Pages on microbit.org, please send the suggested changes or new HTML content to email@example.com.