🌐 Add Polish translation for docs/pl/docs/tutorial/index.md
#4516
Conversation
There was a problem hiding this comment.
Hi @MKaczkow
Thanks for providing this PR 👍
First of all, I've pulled your forked project so it's not only review by looking at changes.
This is kind of "important", because we will decide what translation of topics names Advanced User Guide and Tutorial - User Guide will be, this can be hardly changed ever in the future.
I would definitely opt for my last review comment and change in mkdocs.yml, I've searched through other languages like PT, they seem to follow mkdocs.yml syntax just like I did. Rest of comments are just to consider. Have a good day ;)
docs/pl/docs/tutorial/index.md
Outdated
|
|
||
| Jako pierwszy krok zainstaluj FastAPI. | ||
|
|
||
| Na potrzeby samouczka lepiej zainstaluj ze wszystkimi opcjonalnymi zależnościami i funkcjami: |
There was a problem hiding this comment.
Na potrzeby samouczka lepiej zainstaluj ze wszystkimi opcjonalnymi zależnościami i funkcjami:
Better:
Na potrzeby samouczka możesz zainstalować również wszystkie opcjonalne biblioteki:
|
|
||
| **BARDZO zalecamy** pisanie bądź kopiowanie kodu, edycję, a następnie wykonywanie go lokalnie. | ||
|
|
||
| Użycie w Twoim edytorze jest tym, co pokazuje prawdziwe korzyści z FastAPI, pozwala zobaczyć jak mało kodu musisz napisać, wszystkie funkcje, takie jak kontrola typów, <abbr title="auto-complete, autocompletion, IntelliSense">automatyczne uzupełnianie</abbr>, itd. |
There was a problem hiding this comment.
<abbr title="auto-complete, autocompletion, IntelliSense"></abbr> tag is a nice addon I liked it, indeed I found very few browser search engine results for "automatyczne uzupełnianie", and hardly any is related with "autocompletion".
Anyway I would go for
Użycie w Twoim edytorze jest tym, co pokazuje prawdziwe korzyści z FastAPI, pozwala zobaczyć jak mało kodu musisz napisać oraz wszystkie jego funkcje, takie jak kontrola typów, <abbr title="auto-complete, autocompletion, IntelliSense">automatyczne uzupełnianie</abbr>, itd.
docs/pl/docs/tutorial/index.md
Outdated
|
|
||
| ## Wykonywanie kodu | ||
|
|
||
| Wszystkie fragmenty kodu mogą być skopiowane bezpośrednio i użyte (są poprawnymi i przetestowanymi plikami) |
There was a problem hiding this comment.
Missing dot:
Wszystkie fragmenty kodu mogą być skopiowane bezpośrednio i użyte (są poprawnymi i przetestowanymi plikami).
docs/pl/docs/tutorial/index.md
Outdated
| @@ -0,0 +1,81 @@ | |||
| # Samouczek - Instrukcja - Wprowadzenie | |||
There was a problem hiding this comment.
I would change to simpler # Samouczek - Wprowadzenie, see my comment in mkdocs.yml
docs/pl/docs/tutorial/index.md
Outdated
| !!! note | ||
| You can also install it part by part. | ||
|
|
||
| This is what you would probably do once you want to deploy your application to production: | ||
|
|
||
| ``` | ||
| pip install fastapi | ||
| ``` | ||
|
|
||
| Also install `uvicorn` to work as the server: | ||
|
|
||
| ``` | ||
| pip install "uvicorn[standard]" | ||
| ``` | ||
|
|
||
| And the same for each of the optional dependencies that you want to use. |
There was a problem hiding this comment.
Shoudn't it be in English 
Or maybe it's some convention to leave notes alone?
docs/pl/docs/tutorial/index.md
Outdated
| ## Instrukcja dla zaawansowanych | ||
|
|
||
| Jest też **Instrukcja dla zaawansowanych**, którą możesz przeczytać po lekturze tego **Samouczka - Instrukcji**. | ||
|
|
||
| **Instrukcja dla zaawansowanych**, opiera się na tym samouczku, używa tych samych pojęć, żeby pokazać Ci kilka dodatkowych funkcji. | ||
|
|
||
| Najpierw przeczytaj **Samouczek - Instrukcja** (czytasz to teraz). | ||
|
|
||
| Samouczek jest zaprojektowany tak, że możesz stworzyć kompletną aplikację używając tylko **Samouczka - Instrukcji**, a następnie rozszerzać ją na różne sposoby, w zależności od potrzeb, używając kilku dodatkowych pomysłów z **Instrukcji dla zaawansowanych** | ||
|
|
There was a problem hiding this comment.
Personally, I would change Instrukcja dla zaawansowanych na Zaawansowany poradnik, it's shorter and sounds better.
Also, as noted in first lines, Samouczek alone is better than Samouczek - Instrukcja (and it's not really correct in Polish grammar as far as I know, we don't use upper case letters in middle of titles in Polish, we adopted that from English). There are also few mistypes over here
So at the end of day, the fixed part may look like:
## Zaawansowany poradnik
Jest też **Zaawansowany poradnik**, który możesz przeczytać po lekturze tego **Samouczka**.
**Zaawansowany poradnik** opiera się na tym samouczku, używa tych samych pojęć, żeby pokazać Ci kilka dodatkowych funkcji.
Najpierw jednak powinieneś przeczytać **Samouczek** (czytasz go teraz).
Ten rozdział jest zaprojektowany tak, że możesz stworzyć kompletną aplikację używając tylko informacji tutaj zawartych, a następnie rozszerzać ją na różne sposoby, w zależności od potrzeb, używając kilku dodatkowych pomysłów z **Zaawansowanego poradnika**.
docs/pl/mkdocs.yml
Outdated
| - Tutorial - User Guide: | ||
| - tutorial/index.md |
There was a problem hiding this comment.
And this is something I would Definitely change to
- Samouczek:
- tutorial/index.mdWe should avoid naming this topic in English, its much better to use Polish here. FastAPI docs are smart enough to fill docs we don't cover in English even if we use Polish name (screenshot), this is probably detected by tutorial/index.md.
See current screenshot (I pulled your forked repo and changed code like above).
fixes and small changes in `tutorial/index.md`
|
Hi @rafsaf, Thank you for reviewing this PR 😃 |
tiangolo
changed the title
docs/pl/docs/tutorial/index.mddocs/pl/docs/tutorial/index.md
Codecov Report
@@ Coverage Diff @@
## master #4516 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 531 531
Lines 13629 13629
=========================================
Hits 13629 13629 Continue to review full report at Codecov.
|
…lo#4516) Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
docs/pl/tutorial/index.mdto polish translation