Skip to content

Commit eec601b

Browse files
committed
Make Transifex_Setup.md and the glossary intro plainer
1 parent c20947d commit eec601b

2 files changed

Lines changed: 26 additions & 30 deletions

File tree

‎GLOSSARY.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Punjabi (pa) Python Docs Glossary
22

3-
Preferred Punjabi terms for translating the Python documentation. Use them so translations stay consistent. For writing style, see `STYLE_GUIDE.md`.
3+
These are the Punjabi terms we use when translating the Python documentation, so that the translation stays consistent. For how we write, see `STYLE_GUIDE.md`.
44

55
# How to Use This Glossary
66

7-
- Use the listed term whenever one exists. Do not introduce variants.
8-
- For a term that is not listed, reuse the wording from existing translations. If there is none, use one wording consistently in the file and propose it as described under "Adding or Changing a Term".
7+
- If a term is listed here, use it. Don't use a variant.
8+
- If it isn't listed, reuse the wording from existing translations. If there is none, follow the steps under "Technical terms" in `STYLE_GUIDE.md` and propose the term as described under "Adding or Changing a Term" below.
99
- Never translate function, module, class and exception names, directives, roles, placeholders or code.
1010

1111
---

‎Transifex_Setup.md‎

Lines changed: 23 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,63 @@
11
# Transifex Guide
22

3-
This guide helps new translators get started in Transifex. Translating and reviewing happen there, so you do not need Git, a fork or a pull request.
3+
This page shows new translators how to start in Transifex. You do all the work there, so you don't need Git, a fork or a pull request.
44

55
## Join the project
66

77
1. Create a Transifex account, or sign in, at <https://app.transifex.com/>.
8-
2. Open the [Python Documentation project](https://explore.transifex.com/python-doc/python-newest/) and press "Join this project".
9-
3. Choose Punjabi (`pa`) and wait for a coordinator to approve you. The coordinators are listed in the [README](README.en.md).
10-
4. Ask a coordinator which resource to start with, so that two people do not work on the same one. A resource is one documentation file, for example `library-fileinput`.
8+
2. Open the [Python Documentation project](https://explore.transifex.com/python-doc/python-newest/) and click "Join this project".
9+
3. Choose Punjabi (`pa`). A coordinator will approve your request. The coordinators are listed in the [README](README.en.md).
10+
4. Ask a coordinator which resource to start with, so that two people don't work on the same one. A resource is one documentation file, for example `library-fileinput`.
1111

12-
If you cannot see Punjabi or your resource, ask a coordinator. Please do not create another project, language or resource.
12+
If you can't see Punjabi or your resource, ask a coordinator. Please don't create another project, language or resource.
1313

1414
## Translate
1515

1616
1. Open the project, choose Punjabi (`pa`) and open your resource in the editor.
17-
2. Use the **Untranslated** filter to see the strings that still need translation.
18-
3. Click a string. The editor shows the English source and a field for your Punjabi translation.
19-
4. Press **Save**. Typing alone does not save the translation. Then go to the next string.
17+
2. Use the **Untranslated** filter to see what still needs translating.
18+
3. Click a string. The editor shows the English text and a field for your Punjabi translation.
19+
4. Click **Save**. Typing alone doesn't save it. Then move on to the next string.
2020

2121
```text
2222
Source: Input and Output
2323
Translation: ਇਨਪੁੱਟ ਅਤੇ ਆਉਟਪੁੱਟ
2424
```
2525

26-
## Keep code and markup
26+
## Code and markup
2727

28-
Python documentation contains code and Sphinx markup, such as `print()`, `os.path`, `:func:`, `{name}`, `%s` and `.. code-block:: python`. Do not translate or change them. Translate only the text around them.
28+
The documentation contains code and Sphinx markup, like `print()`, `os.path`, `:func:`, `{name}`, `%s` and `.. code-block:: python`. Leave these as they are and translate only the text around them.
2929

3030
```text
3131
Source: It uses the :func:`print` function.
3232
Translation: ਇਹ :func:`print` ਫੰਕਸ਼ਨ ਦੀ ਵਰਤੋਂ ਕਰਦਾ ਹੈ।
3333
```
3434

35-
The details are in [RULES.md](RULES.md). Before translating a technical term, check [GLOSSARY.md](GLOSSARY.md). If the term is not there, follow the order in [STYLE_GUIDE.md](STYLE_GUIDE.md), and ask a coordinator if you are unsure. We want clear, natural, technically accurate Punjabi, not a word-for-word copy.
35+
[RULES.md](RULES.md) has the details. Before you translate a technical term, look it up in [GLOSSARY.md](GLOSSARY.md). If it isn't there, follow the steps in [STYLE_GUIDE.md](STYLE_GUIDE.md), and ask a coordinator if you're still unsure. We want Punjabi that is clear and correct, not a word-for-word copy.
3636

37-
## Warnings and errors
37+
## Warnings
3838

39-
Transifex checks a translation when you save it, for example for missing placeholders or changed markup. Read the message and fix the translation before saving again. If you do not understand it, ask a coordinator.
39+
Transifex checks a translation when you save it, for example for missing placeholders or changed markup. Read the message and fix the translation before you save it again. If you don't understand the message, ask a coordinator.
4040

4141
## When you finish a resource
4242

43-
- All strings are translated and saved.
44-
- Code, placeholders and markup are unchanged.
45-
- You followed the glossary and the style guide.
43+
Make sure that all strings are translated and saved, that code, placeholders and markup are unchanged, and that you followed the glossary and the style guide. Then tell a coordinator. A reviewer will approve your translations. Don't mark them as reviewed yourself unless you have reviewer permission.
4644

47-
Then tell a coordinator. A reviewer approves the translations. Please do not mark translations as reviewed yourself unless you have been given reviewer permission.
45+
## Reviewing
4846

49-
## Review
50-
51-
Reviewers use the **Unreviewed** filter, check each string against the review points in [STYLE_GUIDE.md](STYLE_GUIDE.md), and mark it as reviewed. Ask a coordinator for reviewer permission.
47+
Reviewers use the **Unreviewed** filter, check each string against the [review checklist](STYLE_GUIDE.md#review) and mark it as reviewed. Ask a coordinator for reviewer permission.
5248

5349
## What happens next
5450

55-
Reviewed translations are pulled into this repository every day and published at <https://docs.python.org/pa/>. You do not need to upload `.po` files or open pull requests.
51+
Reviewed translations are copied into this repository every day and published at <https://docs.python.org/pa/>. You don't need to upload `.po` files or open pull requests.
5652

5753
## If you get stuck
5854

59-
Ask a coordinator or open an issue if, for example:
55+
Ask a coordinator or open an issue if:
6056

61-
- you cannot see Punjabi or your resource, or you cannot edit a string,
62-
- a check fails and you do not understand why,
63-
- you are unsure whether a word or markup should stay in English,
57+
- you can't see Punjabi or your resource, or you can't edit a string,
58+
- a check fails and you don't know why,
59+
- you're not sure if a word or markup should stay in English,
6460
- an existing translation looks wrong,
65-
- something looks like a Transifex configuration problem.
61+
- something looks like a Transifex setup problem.
6662

67-
Please do not create a new project, resource, language or file to solve a problem yourself.
63+
Please don't create a new project, resource, language or file to fix it yourself.

0 commit comments

Comments
 (0)