Translating

How it works

Initial translations will be realized as forks of original repository. As soon as the current content has been fully translated, the translators will receive commit access to this repo and will be responsible for updating the translation in case of fixes / new content.

Therefore, any issues will not get closed until they were resolved in all existing translations. The maintainer of each translation will have to comment on the issue and report it as fixed.

English will remain the official version, in case adjustments are made to this version, issues will be filed and the translators will have to report the changes etc. as translated.

Translation

As said above, English is the reference for all translations. But that doesn't mean that we want word by word translations. Translations should be identical in all the actual details and explanations, but the wording should sound as natural as possible. But please keep most of the programming terms in English, at least as long as there isn't a "official" translation for them.

Setup

• Fork the repository
• Install Node.js and npm (In case you're running Windows, good luck)
• install the jade, neko, fomatto and node-markdown modules via npm
• create a new folder named after the two-letter code for your language under doc
• copy over the stuff from doc/en and edit the index.json file accordingly

Building

Simply run node build.js to generate the HTML. Then check the site/XX folder and open up the index.html.

Don't worry about the links to the other languages, we'll take care of those as soon as the translation is merged into the main repository.

Committing

File a pull request on the repo as soon as the translation reaches 100%.

Questions & Feedback

File an issue on this repository.