PDEP-14: Publish translations of pandas.pydata.org #57204
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| # PDEP-14: Publish translations of pandas.pydata.org | ||
|
|
||
| - Created: 01 February 2024 | ||
| - Status: Under discussion | ||
| - Discussion: [#56301](https://github.com/pandas-dev/pandas/issues/56301) | ||
| [#57204](https://github.com/pandas-dev/pandas/pull/57204) | ||
| - Author: [Albert Steppi](https://github.com/steppi), | ||
| - Revision: 1 | ||
|
|
||
| ## Abstract | ||
|
|
||
| The suggestion is to have official translations made for content of the core | ||
| project website [pandas.pydata.org](https://pandas.pydata.org) and offer | ||
| a low friction way for users to access these translations on the core | ||
| project website. | ||
|
|
||
| ## Motivation, Scope, Usage, and Impact | ||
|
|
||
| There are many potential users with no or a low level of English proficiency | ||
| who could benefit from quality official translations of the Pandas website | ||
| content. Though translations for all documentation would be valuable, | ||
| producing and maintaining translations for such a large and oft-changing | ||
| collection of text would take an immense and sustained effort which may | ||
| be infeasible. The suggestion is instead to have translations made for only | ||
| a key set of pages from the core project website. | ||
|
Comment on lines
+21
to
+25
There was a problem hiding this comment. I am correct in thinking that anyone would be able to open a PR on the mirror site (if this would be the solution). documentation changes are often good first issues. I assume its the approval process that "would take an immense and sustained effort which may be infeasible." Otherwise do we have an off ramp for when the translator funding ends? There was a problem hiding this comment. Yes, anyone could open a PR, and anyone could contribute translations on Crowdin after asking for an invite. Our hope is to set up a compounding snowball type effect, where we can help build a community of volunteer translators who can help keep translations up to date. There was a problem hiding this comment. Great. pandas is foremost a community driven volunteer project so this aligns well with the project values. |
||
|
|
||
| ## Detailed Description and Implementation | ||
|
|
||
| The bulk of the work for setting up translation infrastructure, finding and | ||
| vetting translators, and working out how to publish translations, will fall | ||
| upon a cross-functional team funded by the [Scientific Python Community & Communications | ||
| Infrastructure grant](https://scientific-python.org/doc/scientific-python-community-and-communications-infrastructure-2022.pdf) | ||
| to work on adding translations for the main websites of all | ||
| [Scientific Python core projects](https://scientific-python.org/specs/core-projects/). | ||
| The hope is to minimize the burden on the core Pandas maintainers. | ||
|
|
||
| No translated content would be hosted within the Pandas repository itself. | ||
| Instead a separate GitHub repository could be set up containing the content | ||
| selected for translation. This repository could then be synced to the Crowdin | ||
| localization management platform as described in | ||
| [Crowdin's documentation](https://support.crowdin.com/github-integration/). | ||
| Crowdin would then provide a user interface for translators, and updates to | ||
| translations would be pushed to a feature branch, with completed translations | ||
| periodically merged into `main` after given approval by trusted | ||
| language-specific admin's working across the Scientific Python core projects | ||
| participating in the translation program. There will be no need for Pandas | ||
| maintainers to verify the quality of translations. | ||
|
|
||
| The result would be a repository containing parallel versions of content from | ||
| pandas.pydata.org, translated into various languages. Translated content could | ||
| then be pulled from this repository during generation of the Pandas website. A | ||
| low friction means of choosing between languages could then be added. Possibly a | ||
| drop-down language selector similar to what now exists for https://numpy.org, or | ||
| simple links similar to what now exists for https://www.sympy.org/en/index.html. | ||
| A developer supported by the "Scientific Python Community & Communications | ||
| Infrastructure grant" could assist with making the changes necessary for the | ||
| Pandas website to support publication of translations. | ||
|
|
||
| If desired, a cron job could be set up on the repository containing translated | ||
| content to check for relevant changes or updates to the Pandas website's content | ||
| and pull them if necessary. Translators could then receive a notification from | ||
| Crowdin that there are new strings to translate. This could help with the | ||
| process of keeping translations up to date. | ||
|
|
||
|
|
||
| ### PDEP History | ||
|
|
||
| - 01 February 2024: Initial draft | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I infer from @datapythonista comments that ideally the proposal should be low friction for contributors as well as the users. i.e. pandas users and volunteers can contribute along side grant funded Quansight staff.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, that's right. Grant funded Quansight staff will work mostly on setting up infrastructure, and helping to coordinate and facilitate. The hope is that most of the translators will be volunteers, or will be supported by small grants we could potentially help find for them.