From Fedora Project Wiki
(improvments)
m (add links)
Line 16: Line 16:
  
 
* Done:
 
* Done:
** #110 POT+PO repositories — design the structure
+
** [https://taiga.fedorainfracloud.org/project/asamalik-antora-for-docs/us/ #110] POT+PO repositories — design the structure
** #111 POT+PO repositories — create them
+
** [https://taiga.fedorainfracloud.org/project/asamalik-antora-for-docs/us/ #111] POT+PO repositories — create them
** #112 Translated source repositories — design the structure
+
** [https://taiga.fedorainfracloud.org/project/asamalik-antora-for-docs/us/ #112] Translated source repositories — design the structure
** #113 Translated source repositories — create them
+
** [https://taiga.fedorainfracloud.org/project/asamalik-antora-for-docs/us/ #113] Translated source repositories — create them
** #114 English source -> POT script — write it
+
** [https://taiga.fedorainfracloud.org/project/asamalik-antora-for-docs/us/ #114] English source -> POT script — write it
** #115 PO -> translated source script — write it
+
** [https://taiga.fedorainfracloud.org/project/asamalik-antora-for-docs/us/ #115] PO -> translated source script — write it
** #119 Build script for translated site — write it
+
** [https://taiga.fedorainfracloud.org/project/asamalik-antora-for-docs/us/ #119] Build script for translated site — write it
** #123 Redesign the structure of the PO and POT repositories
+
** [https://taiga.fedorainfracloud.org/project/asamalik-antora-for-docs/us/ #123] Redesign the structure of the PO and POT repositories
 
* TODO:
 
* TODO:
 
** Fix the language code (we should stick to IETF BCP 47 language tag and not assume anything)
 
** 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.).
 
*** 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)
 
*** 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
+
** [https://taiga.fedorainfracloud.org/project/asamalik-antora-for-docs/us/ #116] Translated UI — determine how it's gonna work
 
*** Includes: browser's language detection for redirection and language button? '''needs better description'''
 
*** Includes: browser's language detection for redirection and language button? '''needs better description'''
** #117 Translated UI — create it
+
** [https://taiga.fedorainfracloud.org/project/asamalik-antora-for-docs/us/ #117] Translated UI — create it
 
*** what does it includes?  '''needs better description'''
 
*** what does it includes?  '''needs better description'''
  
Line 39: Line 39:
 
# translation platform is Zanata or any other tool the Fedora community decide to use
 
# translation platform is Zanata or any other tool the Fedora community decide to use
  
* #120 Process for adding new content — draft it
+
* [https://taiga.fedorainfracloud.org/project/asamalik-antora-for-docs/us/ #120] Process for adding new content — draft it
* #121 Process for adding a new language — draft it
+
* [https://taiga.fedorainfracloud.org/project/asamalik-antora-for-docs/us/ #121] Process for adding a new language — draft it
* #130 Fix: Clicking on the logo should go to a homepage of the current language
+
* [https://taiga.fedorainfracloud.org/project/asamalik-antora-for-docs/us/ #130] Fix: Clicking on the logo should go to a homepage of the current language
* #122 (spike) How do we deal with images?
+
* [https://taiga.fedorainfracloud.org/project/asamalik-antora-for-docs/us/ #122] (spike) How do we deal with images?
 
* Doc generation should use fedora infrastructure (and not Asamalik's computer)
 
* Doc generation should use fedora infrastructure (and not Asamalik's computer)
  
Line 48: Line 48:
  
 
* TODO:
 
* TODO:
** #133 include localized URL in sitemaps
+
** [https://taiga.fedorainfracloud.org/project/asamalik-antora-for-docs/us/ #133] include localized URL in sitemaps
 
** Generally speaking, respect i18n-checker advices https://validator.w3.org/i18n-checker/
 
** Generally speaking, respect i18n-checker advices https://validator.w3.org/i18n-checker/
*** #35 We need to be able to generate “href lang attributes”
+
*** [https://taiga.fedorainfracloud.org/project/asamalik-antora-for-docs/us/ #35] We need to be able to generate “href lang attributes”
 
** RTL texts (arabic, ...)
 
** RTL texts (arabic, ...)
 
** Dedicated documentation
 
** Dedicated documentation

Revision as of 12:32, 25 February 2019

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

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/

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)
    • #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