diff --git a/.github/workflows/update-lint-and-build.yml b/.github/workflows/update-lint-and-build.yml index 692b7aea52..0b44f9fe74 100644 --- a/.github/workflows/update-lint-and-build.yml +++ b/.github/workflows/update-lint-and-build.yml @@ -1,3 +1,5 @@ +name: Translation and Linting Workflow + on: schedule: - cron: '*/30 * * * *' @@ -5,6 +7,7 @@ on: branches: - '*' workflow_dispatch: + jobs: update-translation: runs-on: ubuntu-latest @@ -32,11 +35,17 @@ jobs: - run: ./manage_translation.py fetch env: TX_TOKEN: ${{ secrets.TX_TOKEN }} + # Process README.md - run: python -Werror -m cogapp -rP README.md env: TX_TOKEN: ${{ secrets.TX_TOKEN }} + # Process README.en.md + - run: python -Werror -m cogapp -rP README.en.md + env: + TX_TOKEN: ${{ secrets.TX_TOKEN }} - run: git config --local user.email github-actions@github.com - run: git config --local user.name "GitHub Action's update-translation job" + # Check for changes in README.md - run: > ! git diff -I'^"POT-Creation-Date: ' -I'^"Language-Team: ' -I'^# Copyright (C) 2001-' --exit-code && echo "SIGNIFICANT_CHANGES=1" >> $GITHUB_ENV || exit 0 - run: > @@ -61,6 +70,7 @@ jobs: with: token: ${{ secrets.GITHUB_TOKEN }} event-type: translation-updated + lint: runs-on: ubuntu-latest strategy: @@ -77,6 +87,7 @@ jobs: with: ref: ${{ matrix.version }} - run: sphinx-lint + build-translation: runs-on: ubuntu-latest strategy: @@ -106,6 +117,7 @@ jobs: with: name: build-${{ matrix.version }}-${{ matrix.format }} path: Doc/build/${{ matrix.format }} + output-pdf: runs-on: ubuntu-latest strategy: diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000..f9f188deed --- /dev/null +++ b/README.en.md @@ -0,0 +1,80 @@ +Polish Translation of Python Documentation +======================================== + +![build](https://github.com/python/python-docs-pl/workflows/.github/workflows/update-lint-and-build.yml/badge.svg) +![70.16% Language Switcher](https://img.shields.io/badge/language_switcher-70.16%25-0.svg) +![Total Translation of Documentation](https://img.shields.io/badge/Total-3.75%25-0.svg) +![24 Translators](https://img.shields.io/badge/Translators-24-0.svg) + + +*Przeczytaj to w innym języku: [Polski](README.md)* + +If you find a mistake or have a suggestion, +[let us know](https://github.com/python/python-docs-pl/issues) or fix it yourself: + +* Go to the website of the project [Python Documentation](https://explore.transifex.com/python-doc/python-newest/). +* Click the button "Join this project", to join the Project. +* Create an account on Transifex. +* On the project website pick the language Polish. +* After joining the Project, pick the category you want to fix/translate. + +You can find more information about using Transifex +[in their help guide.](https://help.transifex.com/en/articles/6318216-translating-with-the-web-editor). + +**Translation Progress** + +![translation progress till Polish is added to the language switcher](language-switcher-progress.svg) + +The Polish language will appear in the language switcher in docs.python.org, +[when these categories will be fully translated](https://www.python.org/dev/peps/pep-0545/#add-translation-to-the-language-switcher): +* `bugs`, +* Everything in the `tutorial` section, +* `library/functions`. + +**How to see the newest build of the documentation?** + +Download the latest build from the list of artefacts in the latest GitHub Action (Actions Tab). +Translations are pulled from Transifex around every half hour. +The documentation at https://docs.python.org/pl/ is updated around once daily. + +**Communication Channels** + +* [Discord Python Polska #dokumentacja](https://discord.gg/QB3h2Sxc) +* [Python Documentation Community](https://docs-community.readthedocs.io/en/latest/) +* [Python Translations Working Group](https://mail.python.org/mailman3/lists/translation.python.org/) +* [Python Documentation Special Interest Group](https://www.python.org/community/sigs/current/doc-sig/) + +**License** + +By inviting you to work on a project on the Transifex platform, we offer a contract for +donating your translations to the Python Software Foundation +[under the CC0 license](https://creativecommons.org/publicdomain/zero/1.0/deed.pl). +In return, it will be visible that you are the translator of the part you translated. +You signify your acceptance of this agreement by submitting your work for inclusion in the documentation. + +**Updating Translations** +* `./manage_translation.py recreate_tx_config` +* `./manage_translation.py fetch` +* `cog -rP README.md` + +**Useful Materials** +* [Site Statistics](https://plausible.io/docs.python.org/?filters=%28%28contains,page,%28/pl/%29%29%29) +* [Python Developer's Guide: Documentation](https://devguide.python.org/documentation/) + +**Similar Translation Projects** +* [Projects of the Python Packaging Authority](https://hosted.weblate.org/projects/pypa/-/pl/) +* [Scientific Python Translations](https://scientific-python-translations.github.io/) +* [Localizing Django](https://docs.djangoproject.com/en/dev/internals/contributing/localizing/) diff --git a/README.md b/README.md index 59acf60f66..dd13b05239 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,8 @@ f'''![build](https://github.com/python/python-docs-pl/workflows/.github/workflow ![24 tłumaczy](https://img.shields.io/badge/tłumaczy-24-0.svg) +*Read this in another language: [English](README.en.md)* + Jeśli znalazłeś(-aś) błąd lub masz sugestię, [dodaj zgłoszenie](https://github.com/python/python-docs-pl/issues) w tym projekcie lub napraw go sam(a):