⚠️ This repository is not a package.: The setup.py file is only in this repository as a requirement for building docs. If you'd like to install Qiskit, follow the link.
Qiskit Documentation Localization
First of all, thank you for showing your interest in translating (localizing) Qiskit Documentation! This helps make the documentations more accessible and available to our global community.
If you are interested in contributing to translations, please follow the instructions below.
For signing up to participate in translations:
-
Open the LOCALIZATION_CONTRIBUTORS file. Look for the language header that you'd like to contribute to and sign under there. If you do not find the language that you'd like to contribute to, please read this section
-
Create a pull request (PR) to add your name to the list. Make sure to follow the template to open a Pull Request.
- Each contributor has to create their own PR and sign the CLA.
- If you have an open issue for a language request, add the issue link to the PR.
-
You will be asked to sign the Qiskit Contributors License Agreement (CLA) in your PR, if you have not contributed to Qiskit before; please do so.
-
In the Qiskit-Docs Crowdin project, choose the language that you want to contribute to.
-
Click the Join button and paste the URL of your PR in the dialog box where you are asked why you want to join the Crowdin project. Failing to do so, will result in a delay in approving your request in Crowdin and Pull Request in GitHub. The administrators of the Crowdin project will review your request and give you access as quickly as they can.
-
Connect with other translators and receive updates regarding the project through our slack channel.
Translation Leads (as of June, 2020)
| Language | Translation Leads |
|---|---|
| Brazilian Portuguese | Jose Gilberto Biondo Junior |
| French | Olivier Hess |
| German | Joachim Schaefer |
| Italian | Eleonora Picca |
| Japanese | Yuri Kobayashi |
| Portuguese | Omar Costa Hamido |
| Spanish | Antonio Acuaviva Huertos, Enric Delgado Samper |
| Spanish-Mexico | Carlos Gonzalez |
| Turkish | Ayşin Taşdelen |
When you find an issue in the original documentation
During the process of translating Qiskit documentation, you may identify errors (mostly typos) in the original documentation. Please feel free to suggest corrections by opening an issue by choosing Get Started next to Documentation.
What is Crowdin?
Qiskit documentation is translated (localized) using Crowdin, a software and web localization platform that allows organizations to coordinate translation projects and collaborate with communities to translate materials. Crowdin allows our community of translators to amplify their impact by automatically reusing the work invested translating one sentence to translate other, similar sentences. Crowdin also makes translations resilient to many types of changes to the original material, such as moving sentences around, even across files.
For adding a new language to translate
The Qiskit Localization Project currently supports: Brazilian Portuguese, French, German, Italian, Japanese, Korean, Portuguese, Spanish, Spanish- Mexico, and Turkish.
Japanese and German documentation are now available in the Qiskit Documentation website.
As mentioned in the blog post Qiskit in my language is Qiskit, we want to make sure that translated languages have enough community support to ensure quality and consistency.
If you want to add a new language and become a translation lead, you can open a GitHub issue to start a discussion with the Qiskit team and recruit translation project members. Please refer to the criteria below to receive official support from the administrators for new languages.
What is the criteria for adding a new language?
The general criteria for adding a new language is outlined below.
- A minimum of three contributors are necessary for any new languages to be added to receive official support from the administrators of the localization project.
- In addition to translators, we will need dedicated proof-readers to review the translations and approve accuracy of content in that language to ensure the translations to be released in that language.
- Among the group of contributors, a translation lead must be identified to serve as a liaison with the administrators of the localization project. The lead must contact: Yuri Kobayashi (yurik@jp.ibm.com) by email for the language to be officially listed under this project.
These are general guidelines for joining translation efforts and adding new languages. If you have further questions, please feel free to contact yurik@jp.ibm.com. Thank you.