EZP-26834 : document translation workflow with Crowdin #163

nicolas-bastien · 2017-02-02T09:35:08Z

Documentation for Jira : https://jira.ez.no/browse/EZP-26834

Description

This documents the translation workflow with crowdin.

Test

Test manually

DominikaK

Just some typos and punctuation

DominikaK · 2017-02-02T09:56:07Z

doc/i18n/translation_workflow.md

+
+eZ Platform is translated in several languages with the help of [Crowdin][crowdin-ezplatform].
+
+To organize contribution and allow users to install only what they need, we setup a workflow


To organize contribution and allow users to install only what they need, we set up a workflow

DominikaK · 2017-02-02T09:56:24Z

doc/i18n/translation_workflow.md

+To organize contribution and allow users to install only what they need, we setup a workflow
+based on three steps.
+
+##  eZ Platform i18n : Main translation repository


eZ Platform i18n: Main translation repository

DominikaK · 2017-02-02T09:56:41Z

doc/i18n/translation_workflow.md

+
+##  eZ Platform i18n : Main translation repository
+
+To be able to provide a single translation project on our translators platform, we gathered every translation


To be able to provide a single translation project on our translator platform, we gathered all translation

DominikaK · 2017-02-02T09:56:54Z

doc/i18n/translation_workflow.md

+##  eZ Platform i18n : Main translation repository
+
+To be able to provide a single translation project on our translators platform, we gathered every translation
+files is a single repository which is synchronized with Crowdin.


files in a single repository which is synchronized with Crowdin.

DominikaK · 2017-02-02T09:57:07Z

doc/i18n/translation_workflow.md

+To be able to provide a single translation project on our translators platform, we gathered every translation
+files is a single repository which is synchronized with Crowdin.
+
+Translators can contribute on Crowdin and every contribution are merged in this repository.


Translators can contribute on Crowdin and every contribution is merged into this repository.

DominikaK · 2017-02-02T10:02:53Z

doc/i18n/translation_workflow.md

+
+To allow user to install only what they need, we have splitted every languages in a dedicated package.
+
+Every translation packages are published on [ezplatform-i18n organisation on github][ezplatform-i18n-org]


All translation packages are published on [ezplatform-i18n organisation on github][ezplatform-i18n-org]

DominikaK · 2017-02-02T10:03:11Z

doc/i18n/translation_workflow.md

+
+Every translation packages are published on [ezplatform-i18n organisation on github][ezplatform-i18n-org]
+
+**Important** : this packages are read only, they must be updated with the [eZ Platform i18n git split command][ezplatform-i18n].


Important: these packages are read only, they must be updated with the [eZ Platform i18n git split command][ezplatform-i18n].

DominikaK · 2017-02-02T10:03:50Z

doc/i18n/translation_workflow.md

+
+If you want to install a new language in your project, you just have to install the corresponding package.
+
+For example if you want to translate your application in Portuguese (pt_PT : the only package supported by our QA team ;)),


For example, if you want to translate your application into Portuguese (pt_PT: the only package supported by our QA team ;)),

DominikaK · 2017-02-02T10:03:57Z

doc/i18n/translation_workflow.md

+If you want to install a new language in your project, you just have to install the corresponding package.
+
+For example if you want to translate your application in Portuguese (pt_PT : the only package supported by our QA team ;)),
+you just have to run :


you just have to run:

DominikaK · 2017-02-02T10:04:07Z

doc/i18n/translation_workflow.md

+
+    composer require ezplatform-i18n/ezplatform-i18n-pt_pt
+
+and them clean the cache.


and then clean the cache.

yannickroger · 2017-02-02T10:22:03Z

doc/i18n/translation_workflow.md

+
+**Important** : this packages are read only, they must be updated with the [eZ Platform i18n git split command][ezplatform-i18n].
+
+## Install a new language on your project


I would move this paragraph in README.md on INSTALL.md as it is for users and not contributors

@yannickroger I think it make sense to put that here because it's the end of the workflow to validate that the UI is translate

So who is the persona for that documentation?

For me, installing a language is a regular admin user. While understanding how we integrate crowdin is more for contributors. That's why I would move this paragraph to a "admin" doc file. But we could add a sentence here saying to install a language as stated in install.md

yannickroger · 2017-02-02T10:23:14Z

doc/i18n/translation_workflow.md

+To be able to provide a single translation project on our translators platform, we gathered every translation
+files is a single repository which is synchronized with Crowdin.
+
+Translators can contribute on Crowdin and every contribution are merged in this repository.


You should add a link to the repository

nicolas-bastien · 2017-02-02T14:04:59Z

@DominikaK done thanks a lot, I guess it's obvious we really need doc writers ;-)

@yannickroger I added the link

nicolas-bastien · 2017-02-03T09:46:50Z

doc/i18n/translation_workflow.md

+
+If you want to install a new language in your project, you just have to install the corresponding package.
+
+For example, if you want to translate your application into Portuguese (pt_PT: the only package supported by our QA team ;)),


@pcardiga ;-)

DominikaK

One more proofing pass

DominikaK · 2017-02-08T07:13:32Z

doc/i18n/translation_workflow.md

@@ -4,75 +4,33 @@

 eZ Platform is translated in several languages with the help of [Crowdin][crowdin-ezplatform].

-To organize contribution and allow users to install only what they need, we set up a workflow
-based on three steps.
+This documentation presents you the overall concept from the contribution to the distribution with every actor of it.


This documentation presents the overall concept from contribution to distribution for every participant.

DominikaK · 2017-02-08T07:14:02Z

doc/i18n/translation_workflow.md


-To be able to provide a single translation project on our translator platform, we gathered all translation
-files in a single repository which is synchronized with Crowdin.
+This part is made for contributors to eZ Platform. It will explain you how to format your contribution


This part is for contributors to eZ Platform. It will explain to you how to format your contribution

DominikaK · 2017-02-08T07:14:39Z

doc/i18n/translation_workflow.md


-### Translation extraction
+Then you need to add this new strings in the translation process so they can be translated.


Then you need to add these new strings to the translation process so they can be translated.

DominikaK · 2017-02-08T07:15:16Z

doc/i18n/translation_workflow.md


-### Translation extraction
+Then you need to add this new strings in the translation process so they can be translated.
+This part is made for eZ System team to present the process to send new string for translation.


This part is made for the eZ Systems team to present the process of sending the new string for translation.

DominikaK · 2017-02-08T07:15:40Z

doc/i18n/translation_workflow.md


-**Important**: you'll notice that all files will be updated at least to change the date attribute. If this is the
-only change to a file, please don't commit it.
+When translators have worked, it's time to integrate their translations and distribute it.


When translators are done, it's time to integrate their translations and distribute them.

DominikaK · 2017-02-08T07:25:36Z

doc/i18n/install_translation_package.md

+
+## Introduction
+
+This documentation is made for eZ Platform integrators which realize projects based on eZ Platform and will present you


This documentation is made for eZ Platform integrators who realize projects based on eZ Platform. It will present

DominikaK · 2017-02-08T07:26:01Z

doc/i18n/install_translation_package.md

+## Introduction
+
+This documentation is made for eZ Platform integrators which realize projects based on eZ Platform and will present you
+how to install a new package of translation on your project.


how to install a new package of translation in your project.

DominikaK · 2017-02-08T07:27:01Z

doc/i18n/integrate_new_string_to_translate.md

+
+## Introduction
+
+This documentation is made for eZ System team to present the process to send new string for translation.


This documentation is made for the eZ Systems team to present the process of sending the new string for translation.

DominikaK · 2017-02-08T07:27:40Z

doc/i18n/integrate_new_string_to_translate.md

+
+Before extracting new strings you have to make sure that your eZ Systems bundles are up to date on your eZ Platorm installation.
+
+Then your project should be in dev mode with developement dependancies installed and ezsystems/ezplatform-i18n up to date.


Then your project should be in dev mode with development dependencies installed and ezsystems/ezplatform-i18n up to date.

DominikaK · 2017-02-08T07:28:34Z

doc/i18n/integrate_new_string_to_translate.md

+
+## Add new strings for translation
+
+At this point, this only thing you have to do to add the new string in Crowdin is to merge the PR and make sure that 


At this point, the only thing you have to do to add the new string in Crowdin is to merge the PR and make sure that

bdunogier · 2017-02-13T18:42:40Z

@DominikaK I'm sorry, but would you mind opening up a pull-request against this one with those changes ? This is a lot of them :)

bdunogier · 2017-02-14T10:35:26Z

Review changes by @DominikaK merged to this pull-request.

@DominikaK

Language fixes by @DominikaK.

https://jira.ez.no/browse/EZP-32040

nicolas-bastien requested review from mere-teresa and bdunogier February 2, 2017 09:35

yannickroger self-requested a review February 2, 2017 09:39

nicolas-bastien requested a review from DominikaK February 2, 2017 09:40

DominikaK suggested changes Feb 2, 2017

View reviewed changes

yannickroger suggested changes Feb 2, 2017

View reviewed changes

nicolas-bastien force-pushed the EZP-25430-translation-process-doc branch from 3b823f8 to a9c2a2d Compare February 2, 2017 14:02

nicolas-bastien requested review from yannickroger and DominikaK February 2, 2017 14:05

DominikaK approved these changes Feb 2, 2017

View reviewed changes

nicolas-bastien requested a review from pcardiga February 2, 2017 14:23

nicolas-bastien commented Feb 3, 2017

View reviewed changes

DominikaK approved these changes Feb 8, 2017

View reviewed changes

bdunogier force-pushed the EZP-25430-translation-process-doc branch from d37cc3a to 828811b Compare February 14, 2017 10:55

EZP-26834 : document translation workflow with Crowdin

abc6cac

Language fixes by @DominikaK.

bdunogier force-pushed the EZP-25430-translation-process-doc branch from 828811b to abc6cac Compare February 14, 2017 10:55

bdunogier approved these changes Feb 14, 2017

View reviewed changes

bdunogier changed the base branch from master to 1.8 February 14, 2017 10:57

yannickroger approved these changes Feb 14, 2017

View reviewed changes

bdunogier merged commit 739e4e1 into 1.8 Mar 6, 2017

bdunogier deleted the EZP-25430-translation-process-doc branch March 6, 2017 10:49

andrerom pushed a commit that referenced this pull request Dec 2, 2020

EZP-32040: Redesigned welcome page (#163)

52a8ba4

https://jira.ez.no/browse/EZP-32040

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

EZP-26834 : document translation workflow with Crowdin #163

EZP-26834 : document translation workflow with Crowdin #163

nicolas-bastien commented Feb 2, 2017

DominikaK left a comment

DominikaK Feb 2, 2017

DominikaK Feb 2, 2017

DominikaK Feb 2, 2017

DominikaK Feb 2, 2017

DominikaK Feb 2, 2017

DominikaK Feb 2, 2017

DominikaK Feb 2, 2017

DominikaK Feb 2, 2017

DominikaK Feb 2, 2017

DominikaK Feb 2, 2017

yannickroger Feb 2, 2017

nicolas-bastien Feb 2, 2017

yannickroger Feb 3, 2017 •

edited

Loading

yannickroger Feb 2, 2017

nicolas-bastien commented Feb 2, 2017

nicolas-bastien Feb 3, 2017

pcardiga Feb 3, 2017

DominikaK left a comment

DominikaK Feb 8, 2017

DominikaK Feb 8, 2017

DominikaK Feb 8, 2017

DominikaK Feb 8, 2017

DominikaK Feb 8, 2017

DominikaK Feb 8, 2017

DominikaK Feb 8, 2017

DominikaK Feb 8, 2017

DominikaK Feb 8, 2017

DominikaK Feb 8, 2017

bdunogier commented Feb 13, 2017

bdunogier commented Feb 14, 2017


		eZ Platform is translated in several languages with the help of [Crowdin][crowdin-ezplatform].

		To organize contribution and allow users to install only what they need, we setup a workflow


		## eZ Platform i18n : Main translation repository

		To be able to provide a single translation project on our translators platform, we gathered every translation


		To allow user to install only what they need, we have splitted every languages in a dedicated package.

		Every translation packages are published on [ezplatform-i18n organisation on github][ezplatform-i18n-org]


		Every translation packages are published on [ezplatform-i18n organisation on github][ezplatform-i18n-org]

		Important : this packages are read only, they must be updated with the [eZ Platform i18n git split command][ezplatform-i18n].


		If you want to install a new language in your project, you just have to install the corresponding package.

		For example if you want to translate your application in Portuguese (pt_PT : the only package supported by our QA team ;)),


		composer require ezplatform-i18n/ezplatform-i18n-pt_pt

		and them clean the cache.


		Important : this packages are read only, they must be updated with the [eZ Platform i18n git split command][ezplatform-i18n].

		## Install a new language on your project


		### Translation extraction
		Then you need to add this new strings in the translation process so they can be translated.


		## Introduction

		This documentation is made for eZ Platform integrators which realize projects based on eZ Platform and will present you


		## Introduction

		This documentation is made for eZ System team to present the process to send new string for translation.


		Before extracting new strings you have to make sure that your eZ Systems bundles are up to date on your eZ Platorm installation.

		Then your project should be in dev mode with developement dependancies installed and ezsystems/ezplatform-i18n up to date.


		## Add new strings for translation

		At this point, this only thing you have to do to add the new string in Crowdin is to merge the PR and make sure that

EZP-26834 : document translation workflow with Crowdin #163

EZP-26834 : document translation workflow with Crowdin #163

Conversation

nicolas-bastien commented Feb 2, 2017

Description

Test

DominikaK left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eZ Platform i18n: Main translation repository

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yannickroger Feb 3, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-bastien commented Feb 2, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DominikaK left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bdunogier commented Feb 13, 2017

bdunogier commented Feb 14, 2017

yannickroger Feb 3, 2017 •

edited

Loading