doc: avoid RST files in subdirectory

We are discussing an approach on translation support in
project documents in https://review.openstack.org/#/c/543220/.
In this approach POT files for RST files in subdirectory are
treated differently. In the i18n doc, atc-stats directory is
the only exception and the thing would be much simpler if it
is moved to a top directory.

tools/generatepot.sh is updated accordingly.

Also generatepot.sh is added to pep8 tox env to confirm
generatepot.sh works successfully.

Change-Id: Ia227358cf9681e8d1745f4c260fe9c97ab18a3e7
This commit is contained in:
Akihiro Motoki 2018-04-15 04:54:46 +09:00
parent c44a929d37
commit 1e1a033c8e
13 changed files with 111 additions and 106 deletions

106
doc/source/atc-stats.rst Normal file
View File

@ -0,0 +1,106 @@
===============================
ATC Statistics in past releases
===============================
Queens cycle
------------
No detail data.
Pike cycle
----------
* Period: 2017-01-06 to 2017-06-30
* Patch on governance repository: https://review.openstack.org/483452
* Foundation membership was validated by calling a REST API in
https://openstackid-resources.openstack.org
.. csv-table::
:header-rows: 1
:widths: 2 1 1 1 1 1 2
:file: data/pike.csv
Ocata cycle
-----------
* Period: 2016-08-01 to 2017-01-05
* Patch on governance repository: https://review.openstack.org/#/c/417569/
(`diff <http://git.openstack.org/cgit/openstack/governance/commit/?id=bd71cefff1302ed04fc21faac5cf967365a7d7c7>`__)
* Note: the period is relative short because of release cycle change
* More information: https://releases.openstack.org/ocata/schedule.html &
https://ttx.re/splitting-out-design-summit.html
* [ianychoi] Note: only "translated" metric was considered to follow the
description in I18n contributor guide. After more detail investigation on
previous ATC criteria, review metrics were also considered.
Fortunately, the three translators (jftalta - 117 translated & 2897 reviews,
myamamot - 725 reviews, mucahit - 1241 reviews) are also regarded ATCs from
Newton cycle :) - I keep it as record for the next ATC list changes.
.. csv-table::
:header-rows: 1
:widths: 2 1 1 1 1
:file: data/ocata.csv
Newton cycle
------------
* Period: 2016-02-01 to 2016-07-31
* Patch on governance repository: https://review.openstack.org/#/c/351480/
(`diff <http://git.openstack.org/cgit/openstack/governance/commit/?id=3aa6cb3e52944f8bed250e0714c7373605b2ebc5>`__)
.. csv-table::
:header-rows: 1
:widths: 2 1 1 1 1
:file: data/newton.csv
Mitaka cycle
------------
* Period: 2015-08-01 to 2016-01-30
* Patch on governance repository: https://review.openstack.org/#/c/281145/
(`diff <http://git.openstack.org/cgit/openstack/governance/commit/?id=8b3c83f28102c7b47688fbaca970a52a76eb6de5>`__)
* This following statistics data is calculated using up-to-date
`translation_team.yaml <http://git.openstack.org/cgit/openstack/i18n/tree/tools/zanata/translation_team.yaml?id=a67e08d86cc78907da38d5f09b8be6f71d1979a0>`__
(date: Jan 15, 2017).
* When proposing extra ATCs at that time, some translators were not included in
`translation_team.yaml <http://git.openstack.org/cgit/openstack/i18n/tree/tools/zanata/translation_team.yaml?id=73a36041dbdc45212051c60cbeef3f7783200fd2>`__
file. It seems that 1) new translators were joined and the statistics was
calculated but the file was already created, or 2) there might be some lack
of communication with language coordinators, since I18n encouraged each
language coordinator to update this file.
* [ianychoi] Although one year was already passed (as of now: Jan 15, 2017),
I really would like to say those translators also contributed translations
with I18n team members. For acknowledgement purpose, I write their Zanata ID,
name, and language team in here :
* Zbyněk Schwarz (id: tsbook) - Czech
* Rob Cresswell (id: robcresswell) - English (United Kingdom)
* Heleno Jimenez de la Cruz (id: heleno_jimenez) - Spanish (Mexico)
* Jori Kuusinen (id: nuyori) - Finnish (Finland)
* Masaki Matsushita (id: mmasaki) - Japanese
* Amandeep Singh Saini (jimidar) - Punjabi (India)
* Łukasz Jernas (id: deejay1) - Polish (Poland)
.. csv-table::
:header-rows: 1
:widths: 2 1 1 1 1
:file: data/mitaka.csv
Liberty cycle
--------------
* Period: from 2014-11-01 to 2015-07-16
* Patch on governance repository: https://review.openstack.org/#/c/213989/
(`diff <http://git.openstack.org/cgit/openstack/governance/commit/?id=a229d38469c5135af496d3c739695acbe1146a76>`__)
* exported the translators contribution statistics from Transifex since
2014-11-01 to 2015-07-16
* ATC candidates are translators who has translated more than 200 words and
reported their e-mail and name to language coordinators, and also signed
ICLA.
* More information on mailing list:
http://lists.openstack.org/pipermail/openstack-i18n/2015-July/001220.html
* Statistics are available through:
https://docs.google.com/spreadsheets/d/1YpDJU_uNA4I5fzFG69T6L9gpFsy5yNtA9a-lSxnqeAY/edit#gid=1366189722

View File

@ -1,17 +0,0 @@
=============
Liberty cycle
=============
* Period: from 2014-11-01 to 2015-07-16
* Patch on governance repository: https://review.openstack.org/#/c/213989/
(`diff <http://git.openstack.org/cgit/openstack/governance/commit/?id=a229d38469c5135af496d3c739695acbe1146a76>`__)
* exported the translators contribution statistics from Transifex since
2014-11-01 to 2015-07-16
* ATC candidates are translators who has translated more than 200 words and
reported their e-mail and name to language coordinators, and also signed
ICLA.
* More information on mailing list:
http://lists.openstack.org/pipermail/openstack-i18n/2015-July/001220.html
* Statistics are available through:
https://docs.google.com/spreadsheets/d/1YpDJU_uNA4I5fzFG69T6L9gpFsy5yNtA9a-lSxnqeAY/edit#gid=1366189722

View File

@ -1,33 +0,0 @@
============
Mitaka cycle
============
* Period: 2015-08-01 to 2016-01-30
* Patch on governance repository: https://review.openstack.org/#/c/281145/
(`diff <http://git.openstack.org/cgit/openstack/governance/commit/?id=8b3c83f28102c7b47688fbaca970a52a76eb6de5>`__)
* This following statistics data is calculated using up-to-date
`translation_team.yaml <http://git.openstack.org/cgit/openstack/i18n/tree/tools/zanata/translation_team.yaml?id=a67e08d86cc78907da38d5f09b8be6f71d1979a0>`__
(date: Jan 15, 2017).
* When proposing extra ATCs at that time, some translators were not included in
`translation_team.yaml <http://git.openstack.org/cgit/openstack/i18n/tree/tools/zanata/translation_team.yaml?id=73a36041dbdc45212051c60cbeef3f7783200fd2>`__
file. It seems that 1) new translators were joined and the statistics was
calculated but the file was already created, or 2) there might be some lack
of communication with language coordinators, since I18n encouraged each
language coordinator to update this file.
* [ianychoi] Although one year was already passed (as of now: Jan 15, 2017),
I really would like to say those translators also contributed translations
with I18n team members. For acknowledgement purpose, I write their Zanata ID,
name, and language team in here :
* Zbyněk Schwarz (id: tsbook) - Czech
* Rob Cresswell (id: robcresswell) - English (United Kingdom)
* Heleno Jimenez de la Cruz (id: heleno_jimenez) - Spanish (Mexico)
* Jori Kuusinen (id: nuyori) - Finnish (Finland)
* Masaki Matsushita (id: mmasaki) - Japanese
* Amandeep Singh Saini (jimidar) - Punjabi (India)
* Łukasz Jernas (id: deejay1) - Polish (Poland)
.. csv-table::
:header-rows: 1
:widths: 2 1 1 1 1
:file: data/mitaka.csv

View File

@ -1,12 +0,0 @@
============
Newton cycle
============
* Period: 2016-02-01 to 2016-07-31
* Patch on governance repository: https://review.openstack.org/#/c/351480/
(`diff <http://git.openstack.org/cgit/openstack/governance/commit/?id=3aa6cb3e52944f8bed250e0714c7373605b2ebc5>`__)
.. csv-table::
:header-rows: 1
:widths: 2 1 1 1 1
:file: data/newton.csv

View File

@ -1,23 +0,0 @@
===========
Ocata cycle
===========
* Period: 2016-08-01 to 2017-01-05
* Patch on governance repository: https://review.openstack.org/#/c/417569/
(`diff <http://git.openstack.org/cgit/openstack/governance/commit/?id=bd71cefff1302ed04fc21faac5cf967365a7d7c7>`__)
* Note: the period is relative short because of release cycle change
* More information: https://releases.openstack.org/ocata/schedule.html &
https://ttx.re/splitting-out-design-summit.html
* [ianychoi] Note: only "translated" metric was considered to follow the
description in I18n contributor guide. After more detail investigation on
previous ATC criteria, review metrics were also considered.
Fortunately, the three translators (jftalta - 117 translated & 2897 reviews,
myamamot - 725 reviews, mucahit - 1241 reviews) are also regarded ATCs from
Newton cycle :) - I keep it as record for the next ATC list changes.
.. csv-table::
:header-rows: 1
:widths: 2 1 1 1 1
:file: data/ocata.csv

View File

@ -1,13 +0,0 @@
==========
Pike cycle
==========
* Period: 2017-01-06 to 2017-06-30
* Patch on governance repository: https://review.openstack.org/483452
* Foundation membership was validated by calling a REST API in
https://openstackid-resources.openstack.org
.. csv-table::
:header-rows: 1
:widths: 2 1 1 1 1 1 2
:file: data/pike.csv

View File

@ -120,11 +120,7 @@ Translator list is maintained by
`translation_team.yaml <http://git.openstack.org/cgit/openstack/i18n/tree/tools/zanata/translation_team.yaml>`__
stored in `openstack/i18n git repository <http://git.openstack.org/cgit/openstack/i18n>`__.
ATC statistics of past releases are available below:
.. toctree::
:glob:
:reversed:
:maxdepth: 1
:maxdepth: 2
atc-stats/*
atc-stats

View File

@ -28,10 +28,10 @@ fi
rm -f ${DIRECTORY}/source/locale/$DOCNAME.pot
# build i18n contributor guide page index.html
for i in ${DIRECTORY}/source/atc-stats/data/*; do echo -n > $i ; done
for i in ${DIRECTORY}/source/data/*; do echo -n > $i ; done
sphinx-build -j $NUMBER_OF_CORES -b html -b gettext ${DIRECTORY}/source \
${DIRECTORY}/source/locale/
git checkout -- ${DIRECTORY}/source/atc-stats/data/*
git checkout -- ${DIRECTORY}/source/data/*
# Take care of deleting all temporary files so that
# "git add ${DIRECTORY}/source/locale" will only add the

View File

@ -39,6 +39,7 @@ commands =
bash {toxinidir}/tools/check-po.sh {toxinidir}/doc {toxinidir}/glossary
python {toxinidir}/tools/check_yaml_file.py {toxinidir}/tools/zanata/translation_team.yaml
bash {toxinidir}/tools/check-zanata-users-list.sh
{[testenv:generatepot]commands}
whitelist_externals = bash
[testenv:generatepot]