Python Documentation Translation to Bahasa Indonesia (Indonesian Language)
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
Hi 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.
Nice to read \o/
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?
PEP 545 wins, I'll fix the devguide, thanks for noticing.
b. I saw on Python's github repo, many python-doc-{LANG} hosted there, how to request `python-doc-id` on that repository?
You can either transfer the repository to the python organization (clean way I think) or ask me to create one on the python organization and give you permissions on it. If you choose to transfer the repository it's a two step process: - First transfer it to me (github.com/JulienPalard), trust me I'm the PEP 545 author I won't steal the repo :] - Then I'll transfer it to the Python organization. It's because to transfer to an organization you need the right to create a repo in it [1].
c. Is it mandatory to have reviewer on Transifex? I saw not many languages doing reviews on the translation there.
That's not mandatory, yet if you want a good quality I think reviewing is a good step. In France we don't use Transfiex because we're using github pull requests to proofread a lot, and a lot of mistakes are catched at this step [2].
d. and what to do next, if I have completed the translations (a), to be included on language switcher?
Once the repository migrated, open a PR to add your language here: https://github.com/python/docsbuild-scripts/blob/master/build_docs.py#L62 It will build your doc on the server and make it available on docs.python.org so you can check if everything's OK before opening to the public. If everything renders correctly you'll have to open another pull request to add your language to the switcher here: https://github.com/python/cpython/blob/master/Doc/tools/static/switchers.js#... [1]: https://help.github.com/en/articles/transferring-a-repository [2]: https://github.com/python/python-docs-fr/pull/886 Bests, -- Julien Palard https://mdk.fr
Hi Julien, thank you for the clear explanation. On Tue, Oct 15, 2019 at 6:15 AM Julien Palard <julien@palard.fr> wrote:
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?
PEP 545 wins, I'll fix the devguide, thanks for noticing.
great, hope it will encourage more team to comply with PEP 545.
b. I saw on Python's github repo, many python-doc-{LANG} hosted there, how to request `python-doc-id` on that repository?
You can either transfer the repository to the python organization (clean way I think) or ask me to create one on the python organization and give you permissions on it. If you choose to transfer the repository it's a two step process: - First transfer it to me (github.com/JulienPalard), trust me I'm the PEP 545 author I won't steal the repo :] - Then I'll transfer it to the Python organization.
I have transferred the 'python-docs-id' repository to your account. please don't steal it. :D I will wait for the repository available on python organization. \o/
c. Is it mandatory to have reviewer on Transifex? I saw not many languages doing reviews on the translation there.
That's not mandatory, yet if you want a good quality I think reviewing is a good step. In France we don't use Transfiex because we're using github pull requests to proofread a lot, and a lot of mistakes are catched at this step [2].
hm, it's very good example. will gather more people to work on it.
d. and what to do next, if I have completed the translations (a), to be included on language switcher?
Once the repository migrated, open a PR to add your language here: https://github.com/python/docsbuild-scripts/blob/master/build_docs.py#L62
It will build your doc on the server and make it available on docs.python.org so you can check if everything's OK before opening to the public.
If everything renders correctly you'll have to open another pull request to add your language to the switcher here: https://github.com/python/cpython/blob/master/Doc/tools/static/switchers.js#...
I will do this part later, I think I need to test build with 'docsbuild-scripts' first at a local machine.
-- sincerely, oon arfiandwi
o/
I will wait for the repository available on python organization. \o/
Done: https://github.com/python/python-docs-id/
I will do this part later, I think I need to test build with 'docsbuild-scripts' first at a local machine.
You can run a test build locally, like the README says (read the docsbuild-script README there's some important mkdir and venv setup) but adding a --language and a --branch: python3 ./build_docs.py --quick --build-root build_root --www-root www --log-directory logs --group $(id -g) --skip-cache-invalidation --branch 3.8 --languages id The you can browse the doc using: python3 -m http.server -d www/ Tell me how it goes. -- Julien Palard https://mdk.fr
Hi Julien, it's so cool, thank you! On Tue, Oct 15, 2019 at 9:32 PM Julien Palard <julien@palard.fr> wrote:
o/
got it. and I have successfully push commit there. \o/
You can run a test build locally, like the README says (read the docsbuild-script README there's some important mkdir and venv setup) but adding a --language and a --branch:
python3 ./build_docs.py --quick --build-root build_root --www-root www --log-directory logs --group $(id -g) --skip-cache-invalidation --branch 3.8 --languages id
The you can browse the doc using:
python3 -m http.server -d www/
Tell me how it goes.
I will back to you soon with this report. currently, a few hundreds more texts from the tutorial directory, and then build the docs. -- sincerely, oon arfiandwi
Hi Julien, hope this email finds you well. I have finished (committed) all files as required by PEP 545. Currently, I browse the documentation locally, while looking for minor update related to the translation. My next plan would be adding PR to docsbuild-scripts on this weekend. oh, the step to build local docs below is almost perfect, just one additional edit of the build_docs.py related to "LANGUAGES" and " SPHINXOPTS". and all built perfectly. thank you.
You can run a test build locally, like the README says (read the docsbuild-script README there's some important mkdir and venv setup) but adding a --language and a --branch:
python3 ./build_docs.py --quick --build-root build_root --www-root www --log-directory logs --group $(id -g) --skip-cache-invalidation --branch 3.8 --languages id
The you can browse the doc using:
python3 -m http.server -d www/
Tell me how it goes.
-- sincerely, oon arfiandwi
Hi Julien, hope this email finds you well. I have built and tested the documentation in Indonesian with some friends, it looks ok. We still have quite a lot of homework to do, including to fully translate the Spinx, because some of the generated output still in English. On Tue, Oct 15, 2019 at 6:15 AM Julien Palard <julien@palard.fr> wrote:
d. and what to do next, if I have completed the translations (a), to be included on language switcher?
Once the repository migrated, open a PR to add your language here: https://github.com/python/docsbuild-scripts/blob/master/build_docs.py#L62
I propose the next step to build the documentation on docs.python.org server, to gather more persons to help us translate the documentation. So, I created a PR #80 https://github.com/python/docsbuild-scripts/pull/80 would you please merge it? and for the "language switcher", I will create another email in the next few weeks, to make sure that the coverage of the contents is quite good. thank you. -- sincerely, oon arfiandwi
Dear Julien, I hope this email finds you well. happy holiday of all of you on the mailing list. After waiting for about a month now, Our translation at Sphinx has been integrated into version 2.3 (yesterday they release version 2.3.1). I saw your latest PR related to my concern: https://github.com/python/docsbuild-scripts/pull/81 Currently, on https://docs.python.org/id/3.8/ I saw "Created using Sphinx 2.2.1". Would you please give me guidance on what to do to have documentation for language "id" branch "3.8" built using Sphinx "2.3.1"? not in a rush, just let me know after the holiday would be ok. thank you for your support! -- sincerely, oon arfiandwi
I think you would need to update the requirements.txt file to use sphinx==2.3.1 https://github.com/python/docsbuild-scripts/blob/ca26cd4c28f70f3b88c25475098... On Mon, Dec 23, 2019, 9:25 AM oon arfiandwi <oon.arfiandwi@gmail.com> wrote:
Dear Julien, I hope this email finds you well. happy holiday of all of you on the mailing list.
After waiting for about a month now, Our translation at Sphinx has been integrated into version 2.3 (yesterday they release version 2.3.1).
I saw your latest PR related to my concern: https://github.com/python/docsbuild-scripts/pull/81
Currently, on https://docs.python.org/id/3.8/ I saw "Created using Sphinx 2.2.1".
Would you please give me guidance on what to do to have documentation for language "id" branch "3.8" built using Sphinx "2.3.1"?
not in a rush, just let me know after the holiday would be ok.
thank you for your support!
-- sincerely, oon arfiandwi
_______________________________________________ Doc-SIG maillist - Doc-SIG@python.org https://mail.python.org/mailman/listinfo/doc-sig
o/
I think you would need to update the requirements.txt file to use sphinx==2.3.1
https://github.com/python/docsbuild-scripts/blob/ca26cd4c28f70f3b88c25475098...
Yes, but don't worry, I'll take care of it (or someone accustomed to it will), as it will bump sphinx for all languages and all branch at the same time, I have to test everything before bumping.
Would you please give me guidance on what to do to have documentation for language "id" branch "3.8" built using Sphinx "2.3.1"?
Reading you, I feel like your translation *needs* Sphinx 2.3.1, is there any feature from 2.3.1 you need you don't have in 2.2.1? If so I can try to bump soon. If you don't really care about which Sphinx version is used, I'll bump *sometime* (as it takes time to double check everything, I'm not trying to follow upstream sphinx on a daily basis, I only bump from time to time or when we really need it). Bests, -- Julien Palard https://mdk.fr
Hi Julien, On Tue, Dec 24, 2019 at 5:36 AM Julien Palard <julien@palard.fr> wrote:
Reading you, I feel like your translation *needs* Sphinx 2.3.1, is there any feature from 2.3.1 you need you don't have in 2.2.1? If so I can try to bump soon. If you don't really care about which Sphinx version is used, I'll bump *sometime* (as it takes time to double check everything, I'm not trying to follow upstream sphinx on a daily basis, I only bump from time to time or when we really need it).
Yes, it is. We really need Sphinx 2.3+. Previously, we have problem with "translation on Sphinx", here's my issue on sphinx project: https://github.com/sphinx-doc/sphinx/issues/6767 Sphinx project updated (integrated) our translation on version 2.3, that's why we have wait for about a month. I thought the Sphinx version is per language, that's why I have related to your PR. But from your explanation, as it will bump for all languages, I think I will have to wait longer. thank you for your efforts. and also thank you ms Mariatta for the reference. -- sincerely, oon arfiandwi
o/
Yes, it is. We really need Sphinx 2.3+.
Done, all branches and all languages are building using 2.3.1. Happy new year! -- Julien Palard https://mdk.fr
Dear Julien, happy new year. what a great news! yes, I have checked it, got the Sphinx 2.3.1 with the latest translation update. thank you very much. sincerely, oon arfiandwi On Sat, Jan 4, 2020, 10:31 PM Julien Palard <julien@palard.fr> wrote:
o/
Yes, it is. We really need Sphinx 2.3+.
Done, all branches and all languages are building using 2.3.1.
Happy new year! -- Julien Palard https://mdk.fr
participants (3)
-
Julien Palard -
Mariatta -
oon arfiandwi