ka-lite icon indicating copy to clipboard operation
ka-lite copied to clipboard

Feature proposal - docs internationalization

Open MCGallaspy opened this issue 10 years ago • 1 comments

External link Feature Name: Docs Internationalization

Team members:

  • Michael Gallaspy

PR reviewer / Accountabili-buddy: TBD

Description: Right now we just build the docs in English. We want to be able to build the docs in an arbitrary language, and to take our screenshots in a translated version of the app. Sphinx can automatically collect all the strings in the docs into .po files, build .mo files from .po files, and build translated docs, so we just need to find a way to translate the strings in the .po files -- can we use the same crowdsourcing method we have for application strings?

Other TODOs:

  • Take translated screenshots -- simply a matter of starting the server with some specified default language and ensuring the language pack exists on the build machine.
  • Decide how to make our docs available. Currently they’re served and built in one language only.
    • Set up build process for translated docs.
    • Make the docs available online
    • Bundle some form of the docs with the project (or at least the windows installer)

Milestones:

  • Estimated time (tentative date) - Milestone. Tentative timeline starting March 30th, 2015.
  • 1 week (April 3) - Translate screenshots. Set up crowdsourcing of docs string translation.
  • 1 week (April 10) - Create build process for all supported languages and make docs available online.
  • 1 week (April 17) - Build and bundle docs with project (as e.g. PDF)

MCGallaspy avatar Mar 25 '15 21:03 MCGallaspy

Work in progress. See #3717.

MCGallaspy avatar May 26 '15 17:05 MCGallaspy