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

Skip to content

Commit 8d332ac

Browse files
author
Nils Lindemann
committed
Rename chapter and move it one down
1 parent 416aac2 commit 8d332ac

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

docs/en/docs/contributing.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -372,25 +372,6 @@ You can continue with the previous instructions for an "Existing Language" for t
372372

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

375-
#### Tips and tricks for translation
376-
377-
* Translate only the Markdown documents (`.md`). Do not translate the code examples at `./docs_src`.
378-
379-
* In code blocks within the Markdown document, translate comments (`# a comment`), but leave the rest unchanged.
380-
381-
* Do not change anything enclosed in "``" (inline code).
382-
383-
* In lines starting with `===` or `!!!`, translate only the ` "... Text ..."` part. Leave the rest unchanged.
384-
385-
* 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.
386-
387-
* Do not change the paths in links to images, code files, Markdown documents.
388-
389-
* However, when a Markdown document is translated, the `#hash-parts` in links to its headings may change. Update these links if possible.
390-
* Search for such links in the translated document using the regex `#[^# ]`.
391-
* 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".
392-
* When translating a document, do not "pre-translate" `#hash-parts` that link to headings in untranslated documents.
393-
394375
#### Preview the result
395376

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

431412
</div>
432413

414+
#### Translation specific tips and guidelines
415+
416+
* Translate only the Markdown documents (`.md`). Do not translate the code examples at `./docs_src`.
417+
418+
* In code blocks within the Markdown document, translate comments (`# a comment`), but leave the rest unchanged.
419+
420+
* Do not change anything enclosed in "``" (inline code).
421+
422+
* In lines starting with `===` or `!!!`, translate only the ` "... Text ..."` part. Leave the rest unchanged.
423+
424+
* 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.
425+
426+
* Do not change the paths in links to images, code files, Markdown documents.
427+
428+
* However, when a Markdown document is translated, the `#hash-parts` in links to its headings may change. Update these links if possible.
429+
* Search for such links in the translated document using the regex `#[^# ]`.
430+
* 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".
431+
* When translating a document, do not "pre-translate" `#hash-parts` that link to headings in untranslated documents.
432+
433433
## Tests
434434

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

0 commit comments

Comments
 (0)