From 1fd956daa908375661bc99917644660bef13b190 Mon Sep 17 00:00:00 2001 From: Ferrix Hovi Date: Sat, 16 Oct 2021 17:04:22 +0300 Subject: [PATCH 1/5] Translation guide While drafting a Finnish translation, I considered what should be a good process to make translations easy and high quality. --- TRANSLATING.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 TRANSLATING.md diff --git a/TRANSLATING.md b/TRANSLATING.md new file mode 100644 index 0000000..a197585 --- /dev/null +++ b/TRANSLATING.md @@ -0,0 +1,26 @@ +# Guide for translators of the Minimum Viable CD + +In case you want to translate this manifest, follow these guidelines: + +0. Translating the full text of the manifest itself is the minimum viable translation. The FAQ is subject to change more frequently and is optional to translate as long as the links then point to the English version. The list resources is not going to be maintained in several languages. +1. Use common language easily understood by a student of software engineering or a stakeholder working with engineers. +2. If the terms have been translated to the target language before, prefer them over mixing with English and the target language. +3. Replace the bottom of the front page starting from the Signatories with the translated version of this page starting from under the horizontal rule. +4. Update the commit hash and timestamp to the "Translation" subsection. This should make version drift between languages apparent to the reader. +5. Get a peer review side by side from someone who reads both languages fluently and is preferably a native user of the target language. +6. If viable, get a peer review of the translated text from someone who has not read the English text for clarity. +7. Translating the quote from Accelerate is optional if the book has not been translated into the target language. If you translate it yourself, mark it with `(Unofficial translation)` +8. All translations must be stored under a directory named with the ISO 639-1 language code and the file names the same as the originals (even though FAQ does not mean anything in most languages). Example: se/README.md and se/FAQ.md for Northern Sami. +9. Send a pull request that updates the list of translations for navigation. (at the time of writing this document, no such thing exists and will be sorted out then) + +--- + +## Signatories + +The signatories have signed the [original English version](/#signatories) and the current list of names is published only with that version. + +## Translation + +This translation is a community effort in order to help pass this information beyond language barriers. The signatories themselves cannot confirm the correctness of the translation. + +The document version: , From 0a82ed90a7e8620cba3852942305060d902a209f Mon Sep 17 00:00:00 2001 From: Ferrix Hovi Date: Sat, 16 Oct 2021 17:08:17 +0300 Subject: [PATCH 2/5] Typo fix --- TRANSLATING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/TRANSLATING.md b/TRANSLATING.md index a197585..77f2b42 100644 --- a/TRANSLATING.md +++ b/TRANSLATING.md @@ -2,7 +2,7 @@ In case you want to translate this manifest, follow these guidelines: -0. Translating the full text of the manifest itself is the minimum viable translation. The FAQ is subject to change more frequently and is optional to translate as long as the links then point to the English version. The list resources is not going to be maintained in several languages. +0. Translating the full text of the manifest itself is the minimum viable translation. The FAQ is subject to change more frequently and is optional to translate as long as the links then point to the English version. The list of resources is not going to be maintained in several languages. 1. Use common language easily understood by a student of software engineering or a stakeholder working with engineers. 2. If the terms have been translated to the target language before, prefer them over mixing with English and the target language. 3. Replace the bottom of the front page starting from the Signatories with the translated version of this page starting from under the horizontal rule. From 541914cc837b69d0c05911e8bbd62bf957ba83c9 Mon Sep 17 00:00:00 2001 From: Ferrix Hovi Date: Sat, 16 Oct 2021 17:16:53 +0300 Subject: [PATCH 3/5] Update TRANSLATING.md The --- TRANSLATING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/TRANSLATING.md b/TRANSLATING.md index 77f2b42..3271ed7 100644 --- a/TRANSLATING.md +++ b/TRANSLATING.md @@ -23,4 +23,4 @@ The signatories have signed the [original English version](/#signatories) and th This translation is a community effort in order to help pass this information beyond language barriers. The signatories themselves cannot confirm the correctness of the translation. -The document version: , +The document version: _commitish_, _ISO date_ From 0476bd49bdc597e6de070e4947eb2d720a84e5ba Mon Sep 17 00:00:00 2001 From: Ferrix Hovi Date: Sat, 16 Oct 2021 17:17:31 +0300 Subject: [PATCH 4/5] Update TRANSLATING.md --- TRANSLATING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/TRANSLATING.md b/TRANSLATING.md index 3271ed7..c73ad7e 100644 --- a/TRANSLATING.md +++ b/TRANSLATING.md @@ -23,4 +23,4 @@ The signatories have signed the [original English version](/#signatories) and th This translation is a community effort in order to help pass this information beyond language barriers. The signatories themselves cannot confirm the correctness of the translation. -The document version: _commitish_, _ISO date_ +Translated from document version: _commitish_, _ISO date_ From 17c0c60a47031c16cec2af45b6a9100e2e783028 Mon Sep 17 00:00:00 2001 From: Ferrix Hovi Date: Mon, 18 Oct 2021 09:27:07 +0300 Subject: [PATCH 5/5] Update TRANSLATING.md Index from one --- TRANSLATING.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/TRANSLATING.md b/TRANSLATING.md index c73ad7e..d943b4c 100644 --- a/TRANSLATING.md +++ b/TRANSLATING.md @@ -2,16 +2,16 @@ In case you want to translate this manifest, follow these guidelines: -0. Translating the full text of the manifest itself is the minimum viable translation. The FAQ is subject to change more frequently and is optional to translate as long as the links then point to the English version. The list of resources is not going to be maintained in several languages. -1. Use common language easily understood by a student of software engineering or a stakeholder working with engineers. -2. If the terms have been translated to the target language before, prefer them over mixing with English and the target language. -3. Replace the bottom of the front page starting from the Signatories with the translated version of this page starting from under the horizontal rule. -4. Update the commit hash and timestamp to the "Translation" subsection. This should make version drift between languages apparent to the reader. -5. Get a peer review side by side from someone who reads both languages fluently and is preferably a native user of the target language. -6. If viable, get a peer review of the translated text from someone who has not read the English text for clarity. -7. Translating the quote from Accelerate is optional if the book has not been translated into the target language. If you translate it yourself, mark it with `(Unofficial translation)` -8. All translations must be stored under a directory named with the ISO 639-1 language code and the file names the same as the originals (even though FAQ does not mean anything in most languages). Example: se/README.md and se/FAQ.md for Northern Sami. -9. Send a pull request that updates the list of translations for navigation. (at the time of writing this document, no such thing exists and will be sorted out then) +1. Translating the full text of the manifest itself is the minimum viable translation. The FAQ is subject to change more frequently and is optional to translate as long as the links then point to the English version. The list of resources is not going to be maintained in several languages. +2. Use common language easily understood by a student of software engineering or a stakeholder working with engineers. +3. If the terms have been translated to the target language before, prefer them over mixing with English and the target language. +4. Replace the bottom of the front page starting from the Signatories with the translated version of this page starting from under the horizontal rule. +5. Update the commit hash and timestamp to the "Translation" subsection. This should make version drift between languages apparent to the reader. +6. Get a peer review side by side from someone who reads both languages fluently and is preferably a native user of the target language. +7. If viable, get a peer review of the translated text from someone who has not read the English text for clarity. +8. Translating the quote from Accelerate is optional if the book has not been translated into the target language. If you translate it yourself, mark it with `(Unofficial translation)` +9. All translations must be stored under a directory named with the ISO 639-1 language code and the file names the same as the originals (even though FAQ does not mean anything in most languages). Example: se/README.md and se/FAQ.md for Northern Sami. +10. Send a pull request that updates the list of translations for navigation. (at the time of writing this document, no such thing exists and will be sorted out then) ---