From 8311e5ea4c4c7d80770f8eadb601fa759254387b Mon Sep 17 00:00:00 2001 From: patiencedaur Date: Mon, 9 Aug 2021 11:38:06 +0300 Subject: [PATCH 1/5] Add another guideline --- doc/contributing/docs/localization/guide.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/contributing/docs/localization/guide.rst b/doc/contributing/docs/localization/guide.rst index 6afc26092f..4433efa139 100644 --- a/doc/contributing/docs/localization/guide.rst +++ b/doc/contributing/docs/localization/guide.rst @@ -78,6 +78,10 @@ Be creative Please avoid word-for-word translations. Let the resulting text sound as though it was originally written in Russian. +Less is more +~~~~~~~~~~~~ +Be concise. Fewer words are the best option most of the time. + Topic and focus ~~~~~~~~~~~~~~~ Avoid English word order. From 0f994271e0cf1b6c02ed5d6d6b64d1d406f8d4f1 Mon Sep 17 00:00:00 2001 From: patiencedaur Date: Mon, 9 Aug 2021 17:08:55 +0300 Subject: [PATCH 2/5] Add examples --- doc/contributing/docs/localization/guide.rst | 29 +++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/doc/contributing/docs/localization/guide.rst b/doc/contributing/docs/localization/guide.rst index 4433efa139..2188edc33a 100644 --- a/doc/contributing/docs/localization/guide.rst +++ b/doc/contributing/docs/localization/guide.rst @@ -23,6 +23,7 @@ Modal verbs Think twice when translating modal verbs. Avoid using expressions like «вы должны», because they sound like a demand in Russian, and «вам придётся», because it implies that our readers will face a lot of trouble. +Be careful with «нельзя». Make it easy for the user to read the documentation. Gender neutrality @@ -80,7 +81,22 @@ Let the resulting text sound as though it was originally written in Russian. Less is more ~~~~~~~~~~~~ -Be concise. Fewer words are the best option most of the time. +Be concise and don't repeat yourself. Fewer words are the best option most of the time. + +.. container:: table + + .. list-table:: + :widths: 50 50 + :header-rows: 0 + + * - Профиль доступа можно назначить для любой роли пользователя, + созданной администратором. + А к ролям по умолчанию привязать профили доступа не получится, + поскольку такие роли редактировать нельзя. + - Профиль доступа можно назначить для любой роли пользователя, + созданной администратором. + Исключение составляют роли по умолчанию, + поскольку их нельзя редактировать. Topic and focus ~~~~~~~~~~~~~~~ @@ -116,6 +132,17 @@ and don’t use «являться» and «осуществляться» unless To learn how to clear your Russian texts of bureaucratese, check `Timur Anikin's training The Writing Dead `_. +.. container:: table + + .. list-table:: + :widths: 50 50 + :header-rows: 0 + + * - Сообщение исчезнет, как только вы покинете данную страницу. + - Сообщение исчезнет, как только вы покинете страницу. + * - Проверка истечения срока действия паролей производится раз в 30 минут. + - Система раз в 30 минут проверяет, не истек ли срок действия паролей. + Consistency ~~~~~~~~~~~ Use one term for one concept throughout the article. From 0f2966e64d5d2ceeceb8be0be4beb098ad132aba Mon Sep 17 00:00:00 2001 From: patiencedaur Date: Mon, 9 Aug 2021 17:22:51 +0300 Subject: [PATCH 3/5] Add headers to tables --- doc/contributing/docs/localization/guide.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/contributing/docs/localization/guide.rst b/doc/contributing/docs/localization/guide.rst index 2188edc33a..be1fb5a261 100644 --- a/doc/contributing/docs/localization/guide.rst +++ b/doc/contributing/docs/localization/guide.rst @@ -88,7 +88,10 @@ Be concise and don't repeat yourself. Fewer words are the best option most of th .. list-table:: :widths: 50 50 :header-rows: 0 - + + * - + - Don't + - Do * - Профиль доступа можно назначить для любой роли пользователя, созданной администратором. А к ролям по умолчанию привязать профили доступа не получится, @@ -136,8 +139,11 @@ check `Timur Anikin's training The Writing Dead Date: Mon, 9 Aug 2021 17:32:23 +0300 Subject: [PATCH 4/5] Fix typos --- doc/contributing/docs/localization/guide.rst | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/doc/contributing/docs/localization/guide.rst b/doc/contributing/docs/localization/guide.rst index be1fb5a261..1ab379377c 100644 --- a/doc/contributing/docs/localization/guide.rst +++ b/doc/contributing/docs/localization/guide.rst @@ -89,8 +89,7 @@ Be concise and don't repeat yourself. Fewer words are the best option most of th :widths: 50 50 :header-rows: 0 - * - - - Don't + * - Don't - Do * - Профиль доступа можно назначить для любой роли пользователя, созданной администратором. @@ -141,8 +140,7 @@ check `Timur Anikin's training The Writing Dead Date: Mon, 9 Aug 2021 17:47:30 +0300 Subject: [PATCH 5/5] Fix another typo --- doc/contributing/docs/localization/guide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/contributing/docs/localization/guide.rst b/doc/contributing/docs/localization/guide.rst index 1ab379377c..753b31cd10 100644 --- a/doc/contributing/docs/localization/guide.rst +++ b/doc/contributing/docs/localization/guide.rst @@ -87,7 +87,7 @@ Be concise and don't repeat yourself. Fewer words are the best option most of th .. list-table:: :widths: 50 50 - :header-rows: 0 + :header-rows: 1 * - Don't - Do