Skip to content

Commit f8cc509

Browse files
Add English translation of README (#43)
* Create README.en.md * Update README.md * Update README.en.md * Update missing translation README.en.md * Update for README.en.md * Update update-lint-and-build.yml
1 parent 1b5c1ac commit f8cc509

File tree

3 files changed

+94
-0
lines changed

3 files changed

+94
-0
lines changed

.github/workflows/update-lint-and-build.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
1+
name: Translation and Linting Workflow
2+
13
on:
24
schedule:
35
- cron: '*/30 * * * *'
46
push:
57
branches:
68
- '*'
79
workflow_dispatch:
10+
811
jobs:
912
update-translation:
1013
runs-on: ubuntu-latest
@@ -32,11 +35,17 @@ jobs:
3235
- run: ./manage_translation.py fetch
3336
env:
3437
TX_TOKEN: ${{ secrets.TX_TOKEN }}
38+
# Process README.md
3539
- run: python -Werror -m cogapp -rP README.md
3640
env:
3741
TX_TOKEN: ${{ secrets.TX_TOKEN }}
42+
# Process README.en.md
43+
- run: python -Werror -m cogapp -rP README.en.md
44+
env:
45+
TX_TOKEN: ${{ secrets.TX_TOKEN }}
3846
- run: git config --local user.email github-actions@github.com
3947
- run: git config --local user.name "GitHub Action's update-translation job"
48+
# Check for changes in README.md
4049
- run: >
4150
! git diff -I'^"POT-Creation-Date: ' -I'^"Language-Team: ' -I'^# Copyright (C) 2001-' --exit-code && echo "SIGNIFICANT_CHANGES=1" >> $GITHUB_ENV || exit 0
4251
- run: >
@@ -61,6 +70,7 @@ jobs:
6170
with:
6271
token: ${{ secrets.GITHUB_TOKEN }}
6372
event-type: translation-updated
73+
6474
lint:
6575
runs-on: ubuntu-latest
6676
strategy:
@@ -77,6 +87,7 @@ jobs:
7787
with:
7888
ref: ${{ matrix.version }}
7989
- run: sphinx-lint
90+
8091
build-translation:
8192
runs-on: ubuntu-latest
8293
strategy:
@@ -106,6 +117,7 @@ jobs:
106117
with:
107118
name: build-${{ matrix.version }}-${{ matrix.format }}
108119
path: Doc/build/${{ matrix.format }}
120+
109121
output-pdf:
110122
runs-on: ubuntu-latest
111123
strategy:

README.en.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
Polish Translation of Python Documentation
2+
========================================
3+
<!-- [[[cog
4+
from manage_translation import get_resource_language_stats, progress_from_resources, language_switcher, get_number_of_translators
5+
6+
stats = get_resource_language_stats()
7+
switcher = progress_from_resources(filter(language_switcher, stats))
8+
total = progress_from_resources(stats)
9+
translators = get_number_of_translators()
10+
11+
print(
12+
f'''![build](https://github.com/python/python-docs-pl/workflows/.github/workflows/update-lint-and-build.yml/badge.svg)
13+
![{switcher:.2f}% Language Switcher](https://img.shields.io/badge/language_switcher-{switcher:.2f}%25-0.svg)
14+
![Total Translation of Documentation](https://img.shields.io/badge/Total-{total:.2f}%25-0.svg)
15+
![{translators} Translators](https://img.shields.io/badge/Translators-{translators}-0.svg)''')
16+
]]] -->
17+
![build](https://github.com/python/python-docs-pl/workflows/.github/workflows/update-lint-and-build.yml/badge.svg)
18+
![70.16% Language Switcher](https://img.shields.io/badge/language_switcher-70.16%25-0.svg)
19+
![Total Translation of Documentation](https://img.shields.io/badge/Total-3.75%25-0.svg)
20+
![24 Translators](https://img.shields.io/badge/Translators-24-0.svg)
21+
<!-- [[[end]]] -->
22+
23+
*Przeczytaj to w innym języku: [Polski](README.md)*
24+
25+
If you find a mistake or have a suggestion,
26+
[let us know](https://github.com/python/python-docs-pl/issues) or fix it yourself:
27+
28+
* Go to the website of the project [Python Documentation](https://explore.transifex.com/python-doc/python-newest/).
29+
* Click the button "Join this project", to join the Project.
30+
* Create an account on Transifex.
31+
* On the project website pick the language Polish.
32+
* After joining the Project, pick the category you want to fix/translate.
33+
34+
You can find more information about using Transifex
35+
[in their help guide.](https://help.transifex.com/en/articles/6318216-translating-with-the-web-editor).
36+
37+
**Translation Progress**
38+
39+
![translation progress till Polish is added to the language switcher](language-switcher-progress.svg)
40+
41+
The Polish language will appear in the language switcher in docs.python.org,
42+
[when these categories will be fully translated](https://www.python.org/dev/peps/pep-0545/#add-translation-to-the-language-switcher):
43+
* `bugs`,
44+
* Everything in the `tutorial` section,
45+
* `library/functions`.
46+
47+
**How to see the newest build of the documentation?**
48+
49+
Download the latest build from the list of artefacts in the latest GitHub Action (Actions Tab).
50+
Translations are pulled from Transifex around every half hour.
51+
The documentation at https://docs.python.org/pl/ is updated around once daily.
52+
53+
**Communication Channels**
54+
55+
* [Discord Python Polska #dokumentacja](https://discord.gg/QB3h2Sxc)
56+
* [Python Documentation Community](https://docs-community.readthedocs.io/en/latest/)
57+
* [Python Translations Working Group](https://mail.python.org/mailman3/lists/translation.python.org/)
58+
* [Python Documentation Special Interest Group](https://www.python.org/community/sigs/current/doc-sig/)
59+
60+
**License**
61+
62+
By inviting you to work on a project on the Transifex platform, we offer a contract for
63+
donating your translations to the Python Software Foundation
64+
[under the CC0 license](https://creativecommons.org/publicdomain/zero/1.0/deed.pl).
65+
In return, it will be visible that you are the translator of the part you translated.
66+
You signify your acceptance of this agreement by submitting your work for inclusion in the documentation.
67+
68+
**Updating Translations**
69+
* `./manage_translation.py recreate_tx_config`
70+
* `./manage_translation.py fetch`
71+
* `cog -rP README.md`
72+
73+
**Useful Materials**
74+
* [Site Statistics](https://plausible.io/docs.python.org/?filters=%28%28contains,page,%28/pl/%29%29%29)
75+
* [Python Developer's Guide: Documentation](https://devguide.python.org/documentation/)
76+
77+
**Similar Translation Projects**
78+
* [Projects of the Python Packaging Authority](https://hosted.weblate.org/projects/pypa/-/pl/)
79+
* [Scientific Python Translations](https://scientific-python-translations.github.io/)
80+
* [Localizing Django](https://docs.djangoproject.com/en/dev/internals/contributing/localizing/)

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ f'''![build](https://github.com/python/python-docs-pl/workflows/.github/workflow
2020
![24 tłumaczy](https://img.shields.io/badge/tłumaczy-24-0.svg)
2121
<!-- [[[end]]] -->
2222

23+
*Read this in another language: [English](README.en.md)*
24+
2325
Jeśli znalazłeś(-aś) błąd lub masz sugestię,
2426
[dodaj zgłoszenie](https://github.com/python/python-docs-pl/issues) w tym projekcie lub
2527
napraw go sam(a):

0 commit comments

Comments
 (0)