Skip to content

Commit 9bb722e

Browse files
committed
Port changes to English version
1 parent 43d6848 commit 9bb722e

1 file changed

Lines changed: 63 additions & 19 deletions

File tree

README.en.md

Lines changed: 63 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -25,66 +25,110 @@ f'''[![build](https://github.com/python/python-docs-pl/actions/workflows/update-
2525

2626
*Przeczytaj to w innym języku: [polski](README.md)*
2727

28-
**I found a mistake, what do I do?**
28+
### How do I check what needs translating?
2929

30-
If you find a mistake or have a suggestion,
31-
[let us know](https://github.com/python/python-docs-pl/issues) or fix it yourself:
30+
Use the `potodo` package. Run it in the project's root directory, for example: `uvx potodo`.
3231

33-
* Go to the website of the project [Python Documentation](https://explore.transifex.com/python-doc/python-newest/).
34-
* Click the button "Join this project", to join the Project.
32+
If you are interested in the core articles, use filtering. For example:
33+
34+
```
35+
$ uvx potodo --exclude '**/*' '!tutorial/*' '!bugs.po' '!library/functions.po'`
36+
1 directory 99.68% done
37+
└── python-docs-pl/ 99.68% done
38+
├── library/ 98.61% done
39+
│ └── functions.po 99.0% translated 535/536
40+
└── tutorial/ 100.00% done
41+
```
42+
43+
Suggested priority resources for translation can be found in [issue #50](https://github.com/python/python-docs-pl/issues/50).
44+
45+
### How do I translate?
46+
47+
* Go to the [Python Documentation project](https://explore.transifex.com/python-doc/python-newest/) on Transifex.
48+
* Click the "Join this project" button.
3549
* Create an account on Transifex.
36-
* On the project website pick the language Polish.
37-
* After joining the Project, pick the category you want to fix/translate.
50+
* Select Polish on the project page.
51+
* After submitting your request to join the team, introduce yourself on the [Python Polska #dokumentacja Discord channel](https://discord.gg/QB3h2Sxc). This will help us approve your request sooner.
52+
* After joining the team, select the resource you want to improve or update.
3853

3954
You can find more information about using Transifex
4055
in [their help articles](https://help.transifex.com/en/articles/6318216-translating-with-the-web-editor) or [our guide](https://python-docs-transifex-automation.readthedocs.io/new-translators.html).
4156

42-
**I want to start translating, but I don't know where to start!**
57+
### How do I check my changes locally?
58+
59+
[Install the Transifex CLI](https://github.com/transifex/cli#installation) and save your
60+
[Transifex API token](https://help.transifex.com/en/articles/6248858-generating-an-api-token) to `~/.transifexrc` so that you
61+
can download changes from Transifex. Download the changed chapter, for example:
62+
63+
```
64+
$ tx pull --languages pl python-newest.library--turtle
65+
# Getting info about resources
66+
67+
python-newest.library--turtle - Done
68+
[##############################] (1 / 1)
4369
44-
Firstly, you can join as a translator by following the steps outlined above.
70+
# Pulling files
4571
46-
Then you can start by translating one of our [prioritized resources](https://github.com/python/python-docs-pl/issues/50).
72+
python-newest.library--turtle [pl] - Done
73+
[##############################] (1 / 1)
74+
```
4775

48-
**How to see the newest build of the documentation?**
76+
Run `sphinx-lint` to check your changes, for example:
77+
78+
```
79+
$ uvx sphinx-lint library/turtle.po
80+
No problems found.
81+
```
82+
83+
### How do I see the latest build of the documentation?
4984

5085
Download the latest build from the list of artefacts in the latest GitHub Action (Actions Tab).
51-
Translations are pulled from Transifex around every half hour.
86+
Translations are pulled from Transifex around once an hour.
5287
The documentation at https://docs.python.org/pl/ is updated around once daily.
5388

54-
**Communication Channels**
89+
### How do I build the documentation?
90+
91+
You need a checkout of the CPython repository to build the documentation.
92+
93+
Create a symbolic link (Unix) or a copy (Windows) of the `python-docs-pl` project in the CPython repository's
94+
`Doc/locales/pl` directory, named `LC_MESSAGES`.
95+
96+
Then run `make -C Doc SPHINXOPTS="-D language=pl" html` in the CPython repository to build the documentation.
97+
98+
### Communication channels
5599

56100
* [Discord Python Polska #dokumentacja](https://discord.gg/QB3h2Sxc)
57101
* [Python Documentation Community](https://docs-community.readthedocs.io/)
58102
* [Python Documentation Special Interest Group](https://www.python.org/community/sigs/current/doc-sig/)
59103

60-
**Translation progress**
104+
### Translation progress
61105

62-
<img src="translation_progress_en.svg" alt="Translation progress">
106+
<img src="translation_progress_en.svg" alt="Translation progress">
63107

64108
<!---
65109
Excludes the changelog from calculations.
66110
Made using: https://gist.github.com/StanFromIreland/ce400e0d497018fc8e8eb6b739e0b8eb
67111
--->
68112

69-
**License**
113+
### License
70114

71115
By inviting you to work on a project on the Transifex platform, we offer a contract for
72116
donating your translations to the Python Software Foundation
73117
[under the CC0 license](https://creativecommons.org/publicdomain/zero/1.0/deed.pl).
74118
In return, it will be visible that you are the translator of the part you translated.
75119
You signify your acceptance of this agreement by submitting your work for inclusion in the documentation.
76120

77-
**Updating Translations**
121+
### Repository updates
78122
* `./manage_translation.py recreate_tx_config`
79123
* `./manage_translation.py fetch`
80124
* `cog -rP README.en.md`
81125

82-
**Useful Materials**
126+
### Useful materials
83127
* [Python Developer's Guide: Translating](https://devguide.python.org/documentation/translations/translating/)
84128
* [Python docs Transifex: Documentation](https://python-docs-transifex-automation.readthedocs.io/)
85129
* [Site Statistics](https://analytics.python.org/docs.python.org?f=contains,page,/pl/)
86130

87-
**Similar Translation Projects**
131+
### Similar projects
88132
* [Projects of the Python Packaging Authority](https://hosted.weblate.org/projects/pypa/-/pl/)
89133
* [Scientific Python Translations](https://scientific-python-translations.github.io/)
90134
* [micro:bit translation programme](https://microbit.org/translate/)

0 commit comments

Comments
 (0)