From 7e067195728a1a95d5802182f7ebec580ae32104 Mon Sep 17 00:00:00 2001 From: meowmeowcat <68463158+meowmeowmeowcat@users.noreply.github.com> Date: Wed, 14 Jul 2021 22:56:30 +0800 Subject: [PATCH 01/11] Add Translation Guide --- source/contribute.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/source/contribute.rst b/source/contribute.rst index 3709d341f..1d356e06b 100644 --- a/source/contribute.rst +++ b/source/contribute.rst @@ -11,6 +11,7 @@ including: * Reviewing new contributions * Revising existing content * Writing new content +* Translate the guide Most of the work on the |PyPUG| takes place on the `project's GitHub repository`__. To get started, check out the list of @@ -67,6 +68,32 @@ an agreed-upon interface for interoperability between packaging tools. :doc:`example specification-style document `. +Translations +============ + +We use `Weblate`__ to manage translations of this project. +Please visit the `packaging.python.org`__ project on Weblate to contribute. + +If you are experiencing issues while you are working on translations, +please open an issue on `Github `. +please open an issue on `Github`__. + +.. __: https://weblate.org/ +.. __: https://hosted.weblate.org/projects/pypa/packaging-python-org/ +.. __: https://github.com/pypa/packaging.python.org/issues + +Adding a language +----------------- + +If your language is not listed on `Weblate`__, click the button +"Start new translation" at the bottom of the languages list and add +the language you want to translate. + +.. __: https://hosted.weblate.org/projects/pypa/packaging-python-org/ + +.. Note:: Any translations of this project should follow `RST syntax`__. + +.. __: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html Building the guide locally From 57e8e767c722e9964c6f4d280d9bca6fda034861 Mon Sep 17 00:00:00 2001 From: meowmeowcat <68463158+meowmeowmeowcat@users.noreply.github.com> Date: Wed, 14 Jul 2021 23:04:06 +0800 Subject: [PATCH 02/11] Update Translation Guideline --- source/contribute.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/source/contribute.rst b/source/contribute.rst index 1d356e06b..a2ed330bb 100644 --- a/source/contribute.rst +++ b/source/contribute.rst @@ -75,7 +75,6 @@ We use `Weblate`__ to manage translations of this project. Please visit the `packaging.python.org`__ project on Weblate to contribute. If you are experiencing issues while you are working on translations, -please open an issue on `Github `. please open an issue on `Github`__. .. __: https://weblate.org/ From 0810b46f4c53d83f2144b606fcdddf23b54a5645 Mon Sep 17 00:00:00 2001 From: meowmeowcat <68463158+meowmeowmeowcat@users.noreply.github.com> Date: Sat, 17 Jul 2021 19:55:32 +0800 Subject: [PATCH 03/11] Update Translation Guide --- source/contribute.rst | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/source/contribute.rst b/source/contribute.rst index a2ed330bb..6adde7265 100644 --- a/source/contribute.rst +++ b/source/contribute.rst @@ -77,9 +77,12 @@ Please visit the `packaging.python.org`__ project on Weblate to contribute. If you are experiencing issues while you are working on translations, please open an issue on `Github`__. +.. Note:: Any translations of this project should follow `reStructuredText syntax`__. + .. __: https://weblate.org/ .. __: https://hosted.weblate.org/projects/pypa/packaging-python-org/ .. __: https://github.com/pypa/packaging.python.org/issues +.. __: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html Adding a language ----------------- @@ -90,10 +93,24 @@ the language you want to translate. .. __: https://hosted.weblate.org/projects/pypa/packaging-python-org/ -.. Note:: Any translations of this project should follow `RST syntax`__. +Following reStructuredText syntax +-------------------- -.. __: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html +If you are not familiar with reStructuredText (RST) syntax, please read `this guide`__ +before translating on Weblate. + +Example: + +Wrong: Translate the following text directly:: + + `some ref`_ -> `TRANSLATED TEXT HERE`_ + +Right: Translate the following text with your own language and add reference to the +original language:: + + `some ref`_ -> `TRANSLATED TEXT HERE `_ +.. __: https://docutils.sourceforge.io/docs/user/rst/quickref.html Building the guide locally ========================== From 9e8c75120a5263b68c6e6de0864378f4b23475c1 Mon Sep 17 00:00:00 2001 From: meowmeowcat <68463158+meowmeowmeowcat@users.noreply.github.com> Date: Sat, 17 Jul 2021 20:29:31 +0800 Subject: [PATCH 04/11] Update Translation Guide --- source/contribute.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/contribute.rst b/source/contribute.rst index 6adde7265..3ab8df835 100644 --- a/source/contribute.rst +++ b/source/contribute.rst @@ -94,7 +94,7 @@ the language you want to translate. .. __: https://hosted.weblate.org/projects/pypa/packaging-python-org/ Following reStructuredText syntax --------------------- +--------------------------------- If you are not familiar with reStructuredText (RST) syntax, please read `this guide`__ before translating on Weblate. From bf3dbfcbfaafd690a59de4d1fd77f542882989af Mon Sep 17 00:00:00 2001 From: meowmeowcat Date: Sat, 24 Jul 2021 12:23:06 +0800 Subject: [PATCH 05/11] Update source/contribute.rst Co-authored-by: Sviatoslav Sydorenko --- source/contribute.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/source/contribute.rst b/source/contribute.rst index 3ab8df835..9b4a76c17 100644 --- a/source/contribute.rst +++ b/source/contribute.rst @@ -77,7 +77,9 @@ Please visit the `packaging.python.org`__ project on Weblate to contribute. If you are experiencing issues while you are working on translations, please open an issue on `Github`__. -.. Note:: Any translations of this project should follow `reStructuredText syntax`__. +.. note:: + + Any translations of this project should follow `reStructuredText syntax`__. .. __: https://weblate.org/ .. __: https://hosted.weblate.org/projects/pypa/packaging-python-org/ From 69403ff96800bdc6aca236c13b919eb4db2b116e Mon Sep 17 00:00:00 2001 From: meowmeowcat <68463158+meowmeowmeowcat@users.noreply.github.com> Date: Sat, 24 Jul 2021 13:45:59 +0800 Subject: [PATCH 06/11] Add translation guideline --- source/contribute.rst | 42 +++++++++++++++++++++++------------------- 1 file changed, 23 insertions(+), 19 deletions(-) diff --git a/source/contribute.rst b/source/contribute.rst index 9b4a76c17..afb337432 100644 --- a/source/contribute.rst +++ b/source/contribute.rst @@ -71,48 +71,52 @@ an agreed-upon interface for interoperability between packaging tools. Translations ============ -We use `Weblate`__ to manage translations of this project. -Please visit the `packaging.python.org`__ project on Weblate to contribute. +We use `Weblate`_ to manage translations of this project. +Please visit the `packaging.python.org`_ project on Weblate to contribute. If you are experiencing issues while you are working on translations, -please open an issue on `Github`__. +please open an issue on `Github`_. .. note:: - Any translations of this project should follow `reStructuredText syntax`__. + Any translations of this project should follow `reStructuredText syntax`_. -.. __: https://weblate.org/ -.. __: https://hosted.weblate.org/projects/pypa/packaging-python-org/ -.. __: https://github.com/pypa/packaging.python.org/issues -.. __: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html +.. _Weblate: https://weblate.org/ +.. _packaging.python.org: https://hosted.weblate.org/projects/pypa/packaging-python-org/ +.. _Github: https://github.com/pypa/packaging.python.org/issues +.. _reStructuredText syntax: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html Adding a language ----------------- -If your language is not listed on `Weblate`__, click the button +If your language is not listed on `packaging.python.org`_, click the button "Start new translation" at the bottom of the languages list and add the language you want to translate. -.. __: https://hosted.weblate.org/projects/pypa/packaging-python-org/ - Following reStructuredText syntax --------------------------------- -If you are not familiar with reStructuredText (RST) syntax, please read `this guide`__ +If you are not familiar with reStructuredText (RST) syntax, please read `this guide`_ before translating on Weblate. -Example: +**Do not translate the text in reference directly** + + When translating the text in reference, please do not translate them directly. + + | Wrong: Translate the following text directly: + + .. code-block:: -Wrong: Translate the following text directly:: + `some ref`_ -> `TRANSLATED TEXT HERE`_ - `some ref`_ -> `TRANSLATED TEXT HERE`_ + | Right: Translate the following text with your own language and add reference to the + original language: -Right: Translate the following text with your own language and add reference to the -original language:: + .. code-block:: - `some ref`_ -> `TRANSLATED TEXT HERE `_ + `some ref`_ -> `TRANSLATED TEXT HERE `_ -.. __: https://docutils.sourceforge.io/docs/user/rst/quickref.html +.. _this guide: https://docutils.sourceforge.io/docs/user/rst/quickref.html Building the guide locally ========================== From 91a5274e38c90c79d369fa080dc570d65a34a68b Mon Sep 17 00:00:00 2001 From: meowmeowcat Date: Sat, 24 Jul 2021 15:17:29 +0800 Subject: [PATCH 07/11] Update source/contribute.rst Co-authored-by: Sviatoslav Sydorenko --- source/contribute.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/source/contribute.rst b/source/contribute.rst index 31761ac40..b456cb0be 100644 --- a/source/contribute.rst +++ b/source/contribute.rst @@ -109,8 +109,7 @@ before translating on Weblate. `some ref`_ -> `TRANSLATED TEXT HERE`_ - | Right: Translate the following text with your own language and add reference to the - original language: + | Right: Translate the following text with your own language and add the original reference: .. code-block:: From fa19a9f37f5e08280a2aa4d0c7c1b79234b22977 Mon Sep 17 00:00:00 2001 From: meowmeowcat Date: Sat, 24 Jul 2021 15:22:46 +0800 Subject: [PATCH 08/11] Update source/contribute.rst Co-authored-by: Sviatoslav Sydorenko --- source/contribute.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/contribute.rst b/source/contribute.rst index b456cb0be..920d83fec 100644 --- a/source/contribute.rst +++ b/source/contribute.rst @@ -90,7 +90,7 @@ Adding a language ----------------- If your language is not listed on `packaging.python.org`_, click the button -"Start new translation" at the bottom of the languages list and add +:guilabel:`Start new translation` at the bottom of the language list and add the language you want to translate. Following reStructuredText syntax From d3bba7c692baec3a35b5cc027da3f7c9027fd0f1 Mon Sep 17 00:00:00 2001 From: meowmeowcat Date: Sat, 24 Jul 2021 15:28:19 +0800 Subject: [PATCH 09/11] Update source/contribute.rst Co-authored-by: Sviatoslav Sydorenko --- source/contribute.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/contribute.rst b/source/contribute.rst index 920d83fec..6abd32ee0 100644 --- a/source/contribute.rst +++ b/source/contribute.rst @@ -77,7 +77,7 @@ Please visit the `packaging.python.org`_ project on Weblate to contribute. If you are experiencing issues while you are working on translations, please open an issue on `Github`_. -.. note:: +.. tip:: Any translations of this project should follow `reStructuredText syntax`_. From 82dc3e69b7c8c85a083639b3f0f3ecc72da18462 Mon Sep 17 00:00:00 2001 From: meowmeowcat Date: Sat, 24 Jul 2021 15:28:58 +0800 Subject: [PATCH 10/11] Update source/contribute.rst Co-authored-by: Sviatoslav Sydorenko --- source/contribute.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/contribute.rst b/source/contribute.rst index 6abd32ee0..248973529 100644 --- a/source/contribute.rst +++ b/source/contribute.rst @@ -105,7 +105,7 @@ before translating on Weblate. | Wrong: Translate the following text directly: - .. code-block:: + .. code-block:: rst `some ref`_ -> `TRANSLATED TEXT HERE`_ From f0a55c9a7a10e0be86fc156a86b5945a78123179 Mon Sep 17 00:00:00 2001 From: meowmeowcat Date: Sat, 24 Jul 2021 15:29:04 +0800 Subject: [PATCH 11/11] Update source/contribute.rst Co-authored-by: Sviatoslav Sydorenko --- source/contribute.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/contribute.rst b/source/contribute.rst index 248973529..e51fab8e2 100644 --- a/source/contribute.rst +++ b/source/contribute.rst @@ -111,7 +111,7 @@ before translating on Weblate. | Right: Translate the following text with your own language and add the original reference: - .. code-block:: + .. code-block:: rst `some ref`_ -> `TRANSLATED TEXT HERE `_