Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Internationalize the documentation #4399

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Conversation

Gallaecio
Copy link
Member

I needed the tutorial in Galician for a workshop I’m giving this weekend, so I though I’d take the chance to do this properly.

Changes:

  • Short description of the internationalization and localization process.
  • Addition of POT files and PO files for Galician, although only the tutorial page is translated.

Notes:

  • Having the POT files under version control is common practice, even though they are generated files. More so for PO files, which we could remove from the repository if we ever move to a platform like Transifex, but common practice is to keep them in the same repository as the source code, with the same version tracking. Feel free to ignore their content when reviewing these changes, though.
  • For the languages to actually show up in Read The Docs, we need to create separate projects for them. Because of this, and because it is also common practice, we should define some requirements that a translation has to meet before we will consider adding it to Read The Docs. For example, we could require 90% completion of the intro pages and 50% of the topics. My Galician translation, for example, should definitely not warrant it being published in Read The Docs.
  • While these changes should be enough for any experienced open source translator to translate the documentation, if we ever want to reach a wider translation audience we should consider Transifex, a kind of GitHub for translations (proprietary, yet popular among open source projects for being free, popular and effective).

Fixes #3511

@codecov
Copy link

codecov bot commented Mar 4, 2020

Codecov Report

Merging #4399 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #4399   +/-   ##
=======================================
  Coverage   86.18%   86.18%           
=======================================
  Files         160      160           
  Lines        9632     9632           
  Branches     1414     1414           
=======================================
  Hits         8301     8301           
  Misses       1071     1071           
  Partials      260      260           

docs/conf.py Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Translating the docs
1 participant