Browse Source

📝 Tweak instructions for new translations

pull/13535/head
Sebastián Ramírez 1 week ago
parent
commit
0469ff381e
  1. 42
      .github/DISCUSSION_TEMPLATE/translations.yml
  2. 26
      docs/en/docs/contributing.md

42
.github/DISCUSSION_TEMPLATE/translations.yml

@ -18,9 +18,7 @@ body:
required: true
- label: I searched existing discussions to ensure no one else proposed this language.
required: true
- label: I am a native speaker of the language I want to translate to.
required: true
- label: I understand I need to wait for maintainer approval before starting.
- label: I am a native speaker of the language I want to help translate.
required: true
- type: input
id: language
@ -30,36 +28,18 @@ body:
placeholder: e.g. Latin
validations:
required: true
- type: textarea
id: motivation
attributes:
label: Motivation
description: |
Please explain:
1. Why you want to add this language
2. How you plan to maintain it long-term
placeholder: |
I want to add Latin translation because...
My plan for maintaining it is...
validations:
required: true
- type: textarea
id: contributors
attributes:
label: Community Support
description: |
You need at least 2 other native speakers to help with translations.
Ask them to comment on this discussion expressing their commitment.
List their GitHub usernames below once they've commented.
placeholder: |
The following native speakers have committed to help:
- @username1
- @username2
validations:
required: true
- type: textarea
id: additional_info
attributes:
label: Additional Information
description: Any other relevant information about your translation proposal
- type: markdown
attributes:
value: |
Translations are automatized with AI and then reviewed by native speakers. 🤖 🙋
This allows us to keep them consistent and up-to-date.
If there are several native speakers commenting on this discussion and
committing to help review new translations, the FastAPI team will review it
and potentially make it an official translation. 😎

26
docs/en/docs/contributing.md

@ -317,32 +317,26 @@ Some of these files are updated very frequently and a translation would always b
#### Request a New Language
Let's say that you want to add translations for a language that is not yet translated, not even some pages. For example, Latin.
Let's say that you want to request translations for a language that is not yet translated, not even some pages. For example, Latin.
If there is no discussion for that language, you can start by requesting the new language. For that, you can follow these steps:
1. Create a new discussion following the template.
* Create a new discussion following the template.
* Get a few native speakers to comment on the discussion and commit to help review translations for that language.
2. In the discussion, explain why you want to add the new language, what you plan to do, and how you plan to maintain it.
Once there are several people in the discussion, the FastAPI team can evaluate it and can make it an official translation.
3. Show community interest by:
* Getting at least 2 other native speakers to comment on the discussion expressing interest in helping with translations.
Then the docs will be automatically translated using AI, and the team of native speakers can review the translation, and help tweak the AI prompts.
**Important**: Wait for maintainer approval before starting any translation work.
Once there's a new translation, for example if docs are updated or there's a new section, there will be a comment in the same discussion with the link to the new translation to review.
Approval typically requires:
* Meeting the minimum number of interested contributors.
* A clear plan for maintaining the translations.
* Agreement from existing maintainers.
#### New Language
This will help to prevent duplicate translation efforts, build a collaborative translation community, and ensure that the translations are maintained over time.
/// note
Once your language request is approved, you can proceed with creating translations as described below.
These steps will be performed by the FastAPI team.
#### New Language
Once you have the approval to start a new language, you can proceed. First, you need to know the 2-letter code for the language you want to translate.
///
Checking the link from above (List of ISO 639-1 codes), you can see that the 2-letter code for Latin is `la`.

Loading…
Cancel
Save