Skip to content

Translating the platform into your language

Jesse von Doom edited this page May 12, 2016 · 4 revisions

We've worked hard to pull all language from the CASH admin specifically to enable translations. Now we need to find people willing to help localize the platform for so it can reach new people. If you're willing to help we want to hear from you!

WHAT THIS ENTAILS:

There are three places where all language is stored in the platform repo:

  • /interfaces/admin/components/interface
  • /interfaces/admin/components/text
  • /framework/elements

The admin components have a folder corresponding to a two-character code for each language. ("en" for English, and so on.) For a translation you simply need to duplicate those folders, naming them for the two-letter code for the language you're work on. Each file is a JSON file that contains tiny bits of language that make up instructions, labels, or button text in the interface. (We can help you with JSON...it's easy to work with once you get familiar!)

For elements, all language is stored in an app.json file inside the folder for each element. Adding new language here is a matter of editing the app.json file and making new entries for descriptors, instructions, labels, and defaults.

I CAN HELP! WHAT NEXT?

First we need to get started by creating an issue here on github then working with you in a little more detail on the things mentioned above. If you're comfortable on github already, just start a new issue here: https://github.com/cashmusic/platform/issues/new

Please title the issue "Translation: LANGUAGE" — no need to get too involved in the description, but list out what your comfort level is, what you can contribute, and what else would be needed. From there we can create a launguage-specific branch and tech you how forks and pull requests work...all of it.

And if you're not comfortable using github don't worry. It won't be too hard to get started. Just email us at dev@cashmusic.org and we'll teach you everything you need to know.