From 971018882a0ee64921c879c942a5dd1936a2fa08 Mon Sep 17 00:00:00 2001
From: Stella Rouzi <differentreality@gmail.com>
Date: Fri, 18 Mar 2016 19:23:28 +0200
Subject: [PATCH] Add a readme file for translation

---
 README.md      |  3 +++
 TRANSLATION.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 56 insertions(+)
 create mode 100644 TRANSLATION.md

diff --git a/README.md b/README.md
index 6dff3394..36ffecfd 100644
--- a/README.md
+++ b/README.md
@@ -56,6 +56,9 @@ Travis run its testing routine. If you want to run it locally just `bundle exec
 You can read through current enabled rules in `.rubocop.yml` file. Explanations of the defined [rules](http://rubydoc.info/github/bbatsov/rubocop/master/frames) can be found in modules [Cop::Lint](http://rubydoc.info/github/bbatsov/rubocop/master/Rubocop/Cop/Lint) and [Cop::Style](http://rubydoc.info/github/bbatsov/rubocop/master/Rubocop/Cop/Style).
 Additionally you can read through [community ruby style-guide](https://github.com/bbatsov/ruby-style-guide) to better understand core principles.
 
+# Translation
+Please refer to our [TRANSLATION guide] (TRANSLATION.md)
+
 # Communication
 GitHub issues are the primary way for communicating about specific proposed
 changes to this project. If you have other questions feel free to subscribe to
diff --git a/TRANSLATION.md b/TRANSLATION.md
new file mode 100644
index 00000000..09723a76
--- /dev/null
+++ b/TRANSLATION.md
@@ -0,0 +1,53 @@
+# Translation
+We are using [Transifex] (https://www.transifex.com/opensuse-community/osem/) to manage our translations.
+
+We are also using the _Live_ feature of Transifex. That means that all strings from OSEM instances are automatically collected and are available for translating.
+>Automated collection only works if you use the API key (See at the end of this file)
+
+## 1. Translate
+  * Start translating:
+
+    1. Navigate to the [project's page] (https://www.transifex.com/organization/opensuse-community/dashboard/osem)
+    2. Click **translation** button
+    3. Select **language**
+    4. Select **resource** (events.opensuse.org)
+
+Eg. Assuming you have signed up yourself as a translator for OSEM, to translate in German, for example, you go to: https://www.transifex.com/projects/p/osem/translate/#de_DE/eventsopensuseorg/31056760
+
+  * Request a new language
+
+    If you want to translate OSEM into a language that does not already exist, you can request a new language from the Transifex interface. Your request will have to be approved by an admin of the OSEM project in Transifex.
+
+## 2. Publish translations
+  * How to make translations visible (if you have the proper access):
+    1.  Visit https://www.transifex.com/projects/p/osem/live/#en/events.opensuse.org
+    2.  Click **Publish** (from right sidebar menu)
+    3.  Select the language(s)
+    4.  Click **Publish**
+
+  * How to request to publish translated strings
+
+    After you make sure that you have properly reviewed the newly translated strings (they need to be marked as **reviewed** otherwise they won't go live), you can open a [new issue] (https://github.com/openSUSE/osem/issues/new) with the following information:
+
+    Title: [Transifex] Publish translation for EN
+
+    Content: Publish new reviewed strings for language EN
+
+  (You substitute EN with the initials of the language you want to publish)
+
+> Note: We only publish **reviewed** translated strings
+
+## 3. Use translations
+You can view OSEM in other languages by selecting the language you want from the language selector icon (bottom right corner).
+
+## 4. API key
+  When you run your own instance of OSEM, if you want to have the translations available you need to add the necessary [code] (http://docs.transifex.com/live/webmasters/#api) from Transifex:
+  ```
+    :javascript
+      window.liveSettings = {
+        api_key: "cf866a61277842b39c897c5a0b5ec075",
+        picker: "bottom-right",
+        detectlang: true,
+        autocollect: true
+      };
+```