|
1 | | -# Python Documentation Translation — Punjabi (ਪੰਜਾਬੀ) |
| 1 | +# Punjabi translation of the Python documentation |
2 | 2 |
|
3 | 3 | [ਪੰਜਾਬੀ](README.md) |
4 | 4 |
|
5 | | -Punjabi (Gurmukhi, `pa`) translation of the [Python documentation](https://docs.python.org/). |
| 5 | +This is the Punjabi (Gurmukhi, `pa`) translation of the [Python documentation](https://docs.python.org/). |
6 | 6 |
|
7 | | -- **Read it:** <https://docs.python.org/pa/> |
8 | | -- **Progress:** <https://translations.python.org/> (updated automatically) |
9 | | -- **Translate and review:** [Transifex](https://explore.transifex.com/python-doc/python-newest/), language Punjabi (`pa`) |
10 | | -- **Contribute:** see [CONTRIBUTING.md](CONTRIBUTING.md) |
| 7 | +- Read it: <https://docs.python.org/pa/> |
| 8 | +- See how much is translated: <https://translations.python.org/> |
| 9 | +- Translate and review: [Transifex](https://explore.transifex.com/python-doc/python-newest/), language Punjabi (`pa`) |
| 10 | +- Contribute: [CONTRIBUTING.md](CONTRIBUTING.md) |
11 | 11 |
|
12 | | -## How do we translate? |
| 12 | +## How to translate |
13 | 13 |
|
14 | | -1. Open the [Python Documentation project](https://explore.transifex.com/python-doc/python-newest/) on Transifex. |
15 | | -2. Click "Join this project". Create a Transifex account if you don't have one. |
16 | | -3. Select Punjabi (`pa`) on the project page. |
17 | | -4. After a coordinator approves your request, pick a resource and follow [Transifex_Setup.md](Transifex_Setup.md). |
18 | | -5. A reviewer approves your translations, and the daily sync brings them to this repository. You don't need to open a pull request for translations. |
| 14 | +1. Open the [Python Documentation project](https://explore.transifex.com/python-doc/python-newest/) on Transifex and click "Join this project". You need a Transifex account, so create one if you don't have it yet. |
| 15 | +2. Choose Punjabi (`pa`) on the project page. A coordinator will approve your request. |
| 16 | +3. Pick a resource and start translating. [Transifex_Setup.md](Transifex_Setup.md) explains the steps. |
| 17 | +4. A reviewer checks your translation. Once it's approved, it reaches this repository by itself, so you don't need a pull request. |
19 | 18 |
|
20 | | -## How does it work? |
| 19 | +## How it works |
21 | 20 |
|
22 | | -Translations are written and reviewed in Transifex. A GitHub Actions workflow pulls the **reviewed** translations into this repository every day, into the `3.13`, `3.14` and `3.15` branches. Strings that are translated but not yet reviewed stay in Transifex until they are reviewed, so they are not in the repository yet. |
| 21 | +We translate and review in Transifex. Every day a GitHub Actions workflow copies the reviewed translations into the `3.13`, `3.14` and `3.15` branches of this repository. Strings that are translated but not yet reviewed stay in Transifex. |
23 | 22 |
|
24 | | -Every push and pull request runs `msgfmt --check` on all `.po` files. The Python documentation build uses this repository to publish the Punjabi site. |
| 23 | +Each push and pull request runs `msgfmt --check` on all `.po` files. The Python documentation build then uses this repository to publish the Punjabi site. |
25 | 24 |
|
26 | | -## Guides |
| 25 | +## Other files |
27 | 26 |
|
28 | | -| File | Contents | |
29 | | -|------|----------| |
30 | | -| [CONTRIBUTING.md](CONTRIBUTING.md) | How to contribute, validate and submit changes | |
| 27 | +| File | What's in it | |
| 28 | +|------|--------------| |
| 29 | +| [CONTRIBUTING.md](CONTRIBUTING.md) | How to contribute | |
31 | 30 | | [Transifex_Setup.md](Transifex_Setup.md) | First steps in Transifex | |
32 | | -| [STYLE_GUIDE.md](STYLE_GUIDE.md) | Translation style and conventions | |
33 | | -| [RULES.md](RULES.md) | Detailed rules for markup, placeholders and `.po` files | |
34 | | -| [GLOSSARY.md](GLOSSARY.md) | Preferred Punjabi terminology | |
| 31 | +| [STYLE_GUIDE.md](STYLE_GUIDE.md) | Language and style of the translation | |
| 32 | +| [RULES.md](RULES.md) | Rules for code, markup and `.po` files | |
| 33 | +| [GLOSSARY.md](GLOSSARY.md) | The agreed Punjabi technical terms | |
35 | 34 |
|
36 | 35 | ## Coordinators |
37 | 36 |
|
|
0 commit comments