From f7499b37da5675c92ababdf70d1a2530528979c3 Mon Sep 17 00:00:00 2001 From: Frank Kloeker Date: Mon, 4 Dec 2017 06:02:03 +0100 Subject: [PATCH] Add I18n PTL guide I collected everything I learned so far about activities as PTL and did it in the section called "I18n PTL Guide" Change-Id: Ia39161e7feb0e2b27cff5dda3ee90b5bfa700ed1 --- doc/source/index.rst | 1 + doc/source/infra.rst | 2 + doc/source/ptl.rst | 144 +++++++++++++++++++++++++++++++++++++++++++ doc/source/tools.rst | 2 + 4 files changed, 149 insertions(+) create mode 100644 doc/source/ptl.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 521e9f2..848b914 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -27,6 +27,7 @@ Contents handling_bugs official_translator lang_team + ptl check_translation translation_tips glossary diff --git a/doc/source/infra.rst b/doc/source/infra.rst index 2ca1992..a899994 100644 --- a/doc/source/infra.rst +++ b/doc/source/infra.rst @@ -40,6 +40,8 @@ get new translations (or strings change too much), they will be removed again automatically from the project with a lower threshold of currently **40 percent**. +.. _monitoring-translation-job-status: + Monitoring translation jobs status ---------------------------------- diff --git a/doc/source/ptl.rst b/doc/source/ptl.rst new file mode 100644 index 0000000..e5fe479 --- /dev/null +++ b/doc/source/ptl.rst @@ -0,0 +1,144 @@ +============== +I18n PTL Guide +============== + +As an official project, the responsibility of the I18n PTL is generally +subject to the `Project Team Guide `__. +This chapter describes tasks for I18n PTL and gives some useful hints. +If you want to be I18n PTL or you new in this role, please read carefully. +For all other is this chapter informal. + +Election +-------- + +PTLs are elected by ATCs for each cycle. Please read +`Governance Election Page `__. +Time and rules are announced there and on `OpenStack Developer +Mailing List `__. +Your candidacy is highly encouraged to share via there and on +`OpenStack I18n Mailing List `__ +. The proposal must be submitted to election repository (e.g. +`https://review.openstack.org/#/c/425775/ `__). +For this reason it is a good idea to subscribe to these mailing lists +before :-) + +Cross Project Liaisons +---------------------- + +I18n team participates in cross project liaisons in Oslo, Release +Management, Documentation and Infrastructure. Many other teams are +liaisons in I18n. Visit the `Cross Project Liaisons Wiki Page `__ +and designate a person for the I18n team. Note that such liaison roles +do not have to be I18n PTL. Active I18n cores are highly encouraged. + +Project Goals And Translation Plan +---------------------------------- + +In the beginning of each cycle it is a good idea to think about goals +for the project in the next months and establish a translation plan. +Goals are maybe still left from the last cycle and are to be reviewed. +New goals are to be defined on `PTG `__ +or an equivalent event. Orient the team to the `OpenStack-wide goals +`__. + +The translation plan is announced on `Zanata `__ +and contains the projects with the highest priority in translation. +Usually these are all user-visible projects, like Horizon. + + +I18n Core Team +-------------- + +The PTL is supported in the work by the `I18n core team `__. +He designates such kind of project team members and reviews the list +from time to time. The work of the core team is described in the +`Project Team Guide `__. +Of course, core team member be can also proposed by the project team. + +Launchpad I18n Core Team +------------------------ + +As with I18n Core Team, the same things apply here. Launchpad I18n Core +Team focuses on determining the importance of a translation and/or I18n +bug and triaging bug priorities. You can find the member list on +`Launchpad I18n Core Member list `__. + +Release Management +------------------ + +The work for PTL and Zanata administrator is described in chapter +:doc:`release_management`. This covers also questions about +string freezes and work with stable branches. + +Extra-ATCs Deadline +------------------- + +Each cycle has a date set for Extra-ATCs, e.g. `Queens Cycle +`__. +Maintenance on I18n site is described in chapter :ref:`project-maintenance`. +All the OpenStack members can propose extra ATCs, but I18n PTL is highly +encouraged to report the list in each cycle. Here are some +useful proposals as example: + +* `https://review.openstack.org/#/c/488226/ `__ +* `https://review.openstack.org/#/c/483452/ `__ +* `https://review.openstack.org/#/c/451625/ `__ + +This `Script in I18n repo `__ +collects all users and their activities. + +Daily Work +---------- + +Translation Job Control +~~~~~~~~~~~~~~~~~~~~~~~ + +Translated strings are automatically synced between translation server +and Openstack infrastructure. The procedure is robust, but sometimes +something can go wrong. For this reason there is a section +:ref:`monitoring-translation-job-status` in the infrastructure chapter. + +You can check on `Gerrit `__. +if the translated strings are imported by the project teams. +Core reviewers in each repository are strong encouraged to approve +translation sync patches but do not be sad if the translations are not +accepted. Zanata Sync jobs are repeated every day until they are merged. + +Open reviews I18n repository +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Check from time to time open reviews on `I18n repo +`__. +In addition to the PTL, the core reviewers are responsible. + +Launchpad bugs & blueprints +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Translation bugs are tracked on `Launchpad `__. +Often only the language teams are able to handle translation bugs, e.g. +wrong translation words or senses. PTL fits thereon or designates +bug triage liaison. + +I18n blueprints are listed also on `Launchpad `__. +In normal case a blueprint has an assignee and describes a larger course +of a process. + +I18n IRC Team Meeting +~~~~~~~~~~~~~~~~~~~~~ + +Schedules and rules for the team meeting are described in chapter +:doc:`i18n_team_meeting` +PTL is chairing the meeting or determines someone to takeover. He (the +PTL) also has to check if the meeting time suits most people. +Configuration of chair and time is done by `irc-meeting repo +`__. + +I18n Mailing List Management +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In addtion to IRC, I18n team communication takes place via a mailing +list. The `Mailing List Administrator +`__ +is watching new subscribers, not allowed posts, and all the other +things that come with the operation of such a list. + diff --git a/doc/source/tools.rst b/doc/source/tools.rst index 7b20519..7826a48 100644 --- a/doc/source/tools.rst +++ b/doc/source/tools.rst @@ -213,6 +213,8 @@ Handling horizon projects (Some contribution would be appreciated.) +.. _project-maintenance: + Project maintenance -------------------