User:Jibecfed/fedoradoc-antora-localization

Taiga follow-up: https://taiga.fedorainfracloud.org/project/asamalik-antora-for-docs/epic/1

Overview

English source -> POT files -> PO files -> translated source -> translated site

Build pipeline of fedora-docs including internationalization and localization

Git organization

1. English source => Doc repository ==> (D)
   1. https://pagure.io/projects/fedora-docs/%2A
2. POT files -> PO files => localization repository ==> (L)
   1. https://pagure.io/projects/fedora-l10n/%2A
3. PO files -> localized content
   1. https://pagure.io/fedora-docs/translated-sources/
4. translated source => "web" repository ==> (W)
   1. https://pagure.io/fedora-docs/fedora-docs-web/ (see branches)

Process

1. When there is a change in (D), it will call a job, and update pot files in (L)
2. When there is a change in (L), translation platform will know and get updated
3. When there is a change in translation platform, it will update content in (L)
4. Every day or night, content from (D for EN) and (L for every other languages) are used to generate content for (W), and publish it

Current phase

• We are in Alpha
• We translate in French to validate the tooling.
• We create a few other languages to validate the tool.
• We use a Weblate as a test tool http://translate.holcroft.fr/

How to build

To build translated website, just run the "build-translated.sh" file from: https://pagure.io/fedora-docs/docs-fp-o Note: I wrote an updated script (using local cache to save a LOT OF TIME): https://pagure.io/fork/jibecfed/fedora-docs/docs-fp-o/tree/tracking

To produce new pot from source and new localized content from po files: https://pagure.io/fedora-docs/translations-scripts/ Note: you need commit right on multiple repositories to do so.

Requirements to enter Beta Phase

Beta phase means:

1. translation is open for a few more languages, testing is still active.
2. translation platform is still Weblate as a test tool

• Done:
  • #110 POT+PO repositories — design the structure
  • #111 POT+PO repositories — create them
  • #112 Translated source repositories — design the structure
  • #113 Translated source repositories — create them
  • #114 English source -> POT script — write it
  • #115 PO -> translated source script — write it
  • #119 Build script for translated site — write it
  • #123 Redesign the structure of the PO and POT repositories
• TODO:
  • Fix the language code (we should stick to IETF BCP 47 language tag and not assume anything)
    • Context: a language can have multiple regional declination (and variants, etc.).
    • In this URL: https://docs.fedoraproject.org/fr-FR/docs/ the language code should be fr, because it's how the folder is named. https://pagure.io/fedora-l10n/docs/blob/master/f/po (it's the translation platform who will create the correct folder name)
  • #116 Translated UI — determine how it's gonna work
    • Includes: browser's language detection for redirection and language button? needs better description
  • #117 Translated UI — create it
    • what does it includes? needs better description

Requirements to enter Public Availability

Public Availability means:

1. translation is open for every needed languages.
2. translation platform is Zanata or any other tool the Fedora community decide to use

• #120 Process for adding new content — draft it
• #121 Process for adding a new language — draft it
• #130 Fix: Clicking on the logo should go to a homepage of the current language
• #122 (spike) How do we deal with images?
• Doc generation should use fedora infrastructure (and not Asamalik's computer)

Other needed improvements

• TODO:
  • #133 include localized URL in sitemaps
  • Generally speaking, respect i18n-checker advices https://validator.w3.org/i18n-checker/
    • #35 We need to be able to generate “href lang attributes”
  • RTL texts (arabic, ...)
  • Dedicated documentation