Thanks to visit codestin.com
Credit goes to github.com

Skip to content
Merged
Changes from 1 commit
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
4bccdae
Fix a link
Oct 19, 2023
87042d6
Improve venv setup instructions
Oct 19, 2023
e136460
Rename two headings
Oct 19, 2023
324772f
Fix a few typos, etc.
Oct 19, 2023
ce0eaf6
Add a heading and point to it
Oct 19, 2023
6668828
Switch chapters
Oct 19, 2023
e992920
Remove redundant explanation and restructure
Oct 19, 2023
129e701
Add chapter "Things to be kept as-is"
Oct 19, 2023
e56d9b2
Add introduction sentence
Oct 19, 2023
ce8df22
"small written" -> "low-caps"
Oct 19, 2023
1b28737
Dedent heading by one
Oct 19, 2023
891ca8b
Be more explicit
Oct 19, 2023
9fcacee
Be more explicit
Oct 20, 2023
c6f38a0
Merge branch 'tiangolo:master' into review-en/docs/contributing.md
Oct 20, 2023
240f526
Small improvements
Oct 20, 2023
887cdb9
Info box
Oct 20, 2023
2dfc8cd
Shorten the added section
Oct 20, 2023
3f54fb9
Add hint how to do it in VS Code
Oct 22, 2023
416aac2
Merge branch 'tiangolo:master' into review-en/docs/contributing.md
Oct 25, 2023
8d332ac
Rename chapter and move it one down
Oct 30, 2023
86b73e0
Merge branch 'tiangolo:master' into review-en/docs/contributing.md
Oct 30, 2023
b8f5057
Merge branch 'tiangolo:master' into review-en/docs/contributing.md
Oct 31, 2023
b7a9dd5
Merge branch 'tiangolo:master' into review-en/docs/contributing.md
Nov 29, 2023
f36b0e9
Merge branch 'tiangolo:master' into review-en/docs/contributing.md
Dec 1, 2023
c6c4e90
Sync with #10844
Dec 27, 2023
aef9908
Merge remote-tracking branch 'upstream/master' into review-en/docs/co…
Dec 27, 2023
6aeb512
Fix weird things done by the VS Code merge conflict resolver.
Dec 27, 2023
6aba798
Replace three blank lines with one
Dec 27, 2023
f1dd3c5
✏️ Tweak lin formatk and micro-typo
tiangolo Jan 11, 2024
c7b7a21
Merge branch 'master' into review-en/docs/contributing.md
tiangolo Jan 11, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Rename chapter and move it one down
  • Loading branch information
Nils Lindemann committed Oct 30, 2023
commit 8d332acc665e70c3227deb4d1c1d79e37bfdc922
38 changes: 19 additions & 19 deletions docs/en/docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -372,25 +372,6 @@ You can continue with the previous instructions for an "Existing Language" for t

You can make the first pull request with those two files, `docs/ht/mkdocs.yml` and `docs/ht/index.md`. 🎉

#### Tips and tricks for translation

* Translate only the Markdown documents (`.md`). Do not translate the code examples at `./docs_src`.

* In code blocks within the Markdown document, translate comments (`# a comment`), but leave the rest unchanged.

* Do not change anything enclosed in "``" (inline code).

* In lines starting with `===` or `!!!`, translate only the ` "... Text ..."` part. Leave the rest unchanged.

* You can translate info boxes like `!!! warning` with for example `!!! warning "Achtung"`. But do not change the word immediately after the `!!!`, it determines the color of the info box.

* Do not change the paths in links to images, code files, Markdown documents.

* However, when a Markdown document is translated, the `#hash-parts` in links to its headings may change. Update these links if possible.
* Search for such links in the translated document using the regex `#[^# ]`.
* Search in all documents already translated into your language for `your-translated-document.md`. For example VS Code has an option "Edit" -> "Find in Files".
* When translating a document, do not "pre-translate" `#hash-parts` that link to headings in untranslated documents.

#### Preview the result

As already mentioned above, You can use the `./scripts/docs.py` with the `live` command to preview the results (or `mkdocs serve`).
Expand Down Expand Up @@ -430,6 +411,25 @@ Serving at: http://127.0.0.1:8008

</div>

#### Translation specific tips and guidelines

* Translate only the Markdown documents (`.md`). Do not translate the code examples at `./docs_src`.

* In code blocks within the Markdown document, translate comments (`# a comment`), but leave the rest unchanged.

* Do not change anything enclosed in "``" (inline code).

* In lines starting with `===` or `!!!`, translate only the ` "... Text ..."` part. Leave the rest unchanged.

* You can translate info boxes like `!!! warning` with for example `!!! warning "Achtung"`. But do not change the word immediately after the `!!!`, it determines the color of the info box.

* Do not change the paths in links to images, code files, Markdown documents.

* However, when a Markdown document is translated, the `#hash-parts` in links to its headings may change. Update these links if possible.
* Search for such links in the translated document using the regex `#[^# ]`.
* Search in all documents already translated into your language for `your-translated-document.md`. For example VS Code has an option "Edit" -> "Find in Files".
* When translating a document, do not "pre-translate" `#hash-parts` that link to headings in untranslated documents.

## Tests

There is a script that you can run locally to test all the code and generate coverage reports in HTML:
Expand Down