Mailman 3 December 2019 - Doc-SIG

Status for Transifex-based translations
by Maciek Olko Aug. 1, 2021

Aug. 1, 2021

Hello, I want to share with you a small script that displays translation status for language switcher for Transifex-based translations. The script is using Transifex API [1] and requires Transifex API token. https://github.com/m-aciek/python-docs-pl-status/blob/master/checkstatus.py It generates README.md file with status. Currently, for Polish translation it is 5.17%. Regards, Maciej [1] https://docs.transifex.com/api/resources [2] https://github.com/m-aciek/python-docs-pl-status

3 6

Polish translation
by Maciek Olko Aug. 13, 2020

Aug. 13, 2020

Hello, I'd like to request a designation to coordinator role for Polish translation of Python documentation and a creation of GitHub repository for it. I am currently a Python developer at YouGov. I am coordinator of Django documentation translation into Polish. I am native Polish speaker, my English skills are about C2 CEFR [1]. In couple of days I'd like come up with a plan to efficiently encourage people to join the translation project. Regards, Maciej Olko [1] https://en.wikipedia.org/wiki/Common_European_Framework_of_Reference_for_La…

2 5

Python Documentation Translation to Bahasa Indonesia (Indonesian Language)
by oon arfiandwi Jan. 4, 2020

Jan. 4, 2020

Dear doc-sig members, hope this email finds you well. my name is oon arfiandwi, currently, I'm doing a sprint to translate Python Documentation to Bahasa Indonesia, and in the next few days, it will achieve the minimum requirement, which mentioned on PEP 545, to be able to add to Language Switcher. The translation synchronized between Transifex and my github repo [1]. I have several questions before I continue the process: a. according to devguide site [2], I need to finish `library/stdtypes` too, but it is not mentioned on (current PEP 545). can someone help me to clarify which one is the minimum? b. I saw on Python's github repo, many python-doc-{LANG} hosted there, how to request `python-doc-id` on that repository? c. Is it mandatory to have reviewer on Transifex? I saw not many languages doing reviews on the translation there. d. and what to do next, if I have completed the translations (a), to be included on language switcher? thank you for any help and explanation. [1]: https://github.com/oonid/python-docs-id [2]: https://devguide.python.org/documenting/#starting-a-new-translation -- sincerely, oon arfiandwi

3 12

Automation of fetching changes from Transifex
by Maciek Olko Dec. 30, 2019

Dec. 30, 2019

Hello, I'd like to share Python script [1] and GitHub Action definition [2] which fetch and update translation in python-docs-pl Git repository. It may be of interest for Transifex-only translation flows. manage_translations.py removes location comments from PO files to make diffs in repo more plain. It was inspired by similar script for Django documentation translations made by Claude Paroz [3]. Feel free to contact me in case of any questions. Kind regards, Maciej [1] https://github.com/m-aciek/python-docs-pl/blob/3.8/manage_translations.py#L… [2] https://github.com/m-aciek/python-docs-pl/blob/3.8/.github/workflows/update… [3] https://github.com/django/django-docs-translations/blob/stable/3.0.x/manage…

2 1

a better path from error message to solution
by Marc Chantreux Dec. 24, 2019

Dec. 24, 2019

hello people, i try to educate my children to have a reasonable use of digital ressources so they try to respect 2 rules: * don't use a search engine if you don't need * don't use the bandwith to get something you already have on your machine my kid use python at school and get stuck on very basic errors like TypeError. I realize how difficult it is for a non programmer to make the connexion between the error message and the relevant doc. so: those are ideas i would like to share with your as a perl monger who miss the perl ecosystem when writting python code: * don't stacktrace by default: backtraces are just noise for newbies. * make the messages a little bit informative. maybe with links to the documentation. * have a python module that behaves like perl diagnostics (https://metacpan.org/pod/distribution/perl/lib/diagnostics.pm) at least as a ipython extension. * make pydoc able to show the doc related to an Error * make the official documentation available with man (the way perl does it: man perl gives you the list of other man pages that are both turorials and reference). * have the error messages translated into natural langages hope that helps. regards, marc

2 1

Looking for language coordinators
by tomo cocoa Dec. 11, 2019

Dec. 11, 2019

Hello, all translators First of all, I like to celebrate the GA release of Python 3.8 and congratulate all members related to this release!! I send this email, because I want to share roles on the Transifex project. Currently, all join requests and adding languages requests are approved by me, because I am only the active member assigned roles necessary for approvement. This structure is come from a historical reason, but it is not practical now. I have no idea if I should approve this join request, so I always approve any join request. That is not a healthy way of community management. I suggest that each language groups should have at least two coordinators, who is responsible for overseeing a particular language within a team. For more details, see transifex documents: https://docs.transifex.com/teams/understanding-user-roles#language-coordina… If you have any comment, please let me know. Best regards, cocoatomo -- class Cocoatomo: name = 'cocoatomo' email_address = 'cocoatomo77(a)gmail.com' twitter_id = '@cocoatomo'

5 16

Looking for Translation Help for PyLadies
by Mariatta Dec. 5, 2019

Dec. 5, 2019

Hello, We are looking for volunteers to help us translate the proposal: “PyLadies Global Council Selection Process” into one of the 6 official languages of the UN, which are: Arabic, French, English, Russian, Spanish, and Mandarin Chinese . The text for it can be found at https://github.com/pyladies/global-organizing/issues/32#issue-509308891 The proposal will affect how PyLadies will be governed in the future, and we are actively seeking input and feedback from our community members. However, we realized that our community is global; we recognized the need to have the proposal translated in order to include the diverse voices of PyLadies community members around the world. Within our own community, we’ve had members starting to translate the text into Spanish (by Tania Allard, Lorena Mesa, and Gisela Rosi) and Portuguese (by Debora Azevedo). We still need help with translating to Arabic, French, Russian, and Mandarin Chinese, ideally by December 15. If any of you are able to help, or know someone who could help us, please let me know. I do realize that this might be out of scope of the docs-sig workgroup, so thank you in advance for the consideration and willingness to help PyLadies community. Thanks Mariatta on behalf of PyLadies

1 0

Adjustment of toctree depth
by tomo cocoa Dec. 1, 2019

Dec. 1, 2019

Hi all, I have a suggestion about toctree depth of index pages, such as "Python Setup and Usage." Since Python documentation is hard to grasp items listed on index pages, only items located at top and second level in toctree would be shown in order to mitigate burden of reading the documentation. Thank you for reading this. Best Regards, @cocoatomo -- class Cocoatomo: name = 'cocoatomo' email_address = 'cocoatomo77(a)gmail.com' twitter_id = '@cocoatomo'

2 1