idg.tools icon indicating copy to clipboard operation
idg.tools copied to clipboard

Create a guide for how to contribute with localisation and translation

Open Greenheart opened this issue 1 year ago • 1 comments

Use the following draft to create a proper guide to publish somewhere on the community website. For example a story or on the contributing page.


I promised more info on how to get started with localisation, and here it is. This will become a more detailed and visual guide (incl. screenshots) in the future, but here's a start:

How to contribute with localisation and translations

Also see frequently asked questions at the end of the guide.

  1. Create a GitHub account at https://github.com/ (or if you don't want to create an account, collaborate with another person who can make the changes. Perhaps you can have a video call and screen share while translating together!)

  2. Now you're ready to go to the IDG Community CMS where we edit content, and add translations. Go to https://cms.idg.community/ and sign in with your GitHub account.

  3. Open the content you want to change (for example if you want to translate one of the IDG skills).

  4. Make changes and press "Save" in the top of the page.

  5. When you're happy with your changes and want to submit them to get published, go to https://cms.idg.community/#/workflow and move your changes into the right column.

In the workflow view, your changes first show up as drafts: idg-cms-review

Moving changes to the right column will submit them for review and publishing. idg-cms-review-2

  1. If everything is good, changes will be published and made available with the next update to the website.

Thanks for your contributions!

Welcome to reach out if you have need help - ideally via https://matrix.to/#/#localization:community.innerdevelopmentgoals.org

Let's explore a good process for working on this together! :)

Frequently Asked Questions

How can I see other's translations made through the CMS?

Each change will be listed on https://github.com/Greenheart/idg.tools/pulls, and can be viewed to see the exact changes in that update. It's not as user friendly, and takes some getting used to, but it's a tradeoff we're making right now to get the other benefits of this process.

Why can I only see my own changes in the CMS?

It's unfortunately a limitation in the CMS software, so there is a risk that you might be updating things that others already are working on. However, if we are quick with reviewing and publishing content changes, that should reduce the risk of redundant work. If you want to be sure before starting a translation - make sure to sync with the localisation team via the communication channels.

Greenheart avatar Feb 23 '23 18:02 Greenheart