openstack
/
i18n
Code Issues Proposed changes

Document glossary management 

Change-Id: I8e4d1b206228f5b94042c0748b3dac8f0b7d3641
This commit is contained in:
Akihiro Motoki 2016-09-12 05:45:56 +09:00
parent d7105caa1e
commit d3b42cbf62
2 changed files with 51 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
doc/source/glossary.rst Normal file
View File

@ -0,0 +1,50 @@
===================
Glossary Management
===================
Zanata provides suggestions for translation based on a glossary of your
language. The glossary is maintained in the i18n repository.
Glossary of your language
-------------------------
A glossary file of your language is found at
``i18n/locale/<lang>/LC_MESSAGES/i18n.po`` in the i18n repository.
The file is an usual PO file.
When you want to update a glossary of your language,
edit a corresponding glossary file using your favorite editor and
propose a change to the Gerrit review system.
Once your change is merged, the updated glossary will be uploaded
to Zanata. Note that the upload to Zanata is a **manual** process now.
Only the Zanata administrator (usually the i18n PTL and some limited folks)
can upload an glossary. If your glossary is not uploaded, contact the i18n team
or the PTL via the i18n mailing list.
.. note::
Discuss and review glossary changes in your language team before you propose
changes to the Gerrit review system. Reviewers in the Gerrit review system
cannot understand your language in most cases, so they can only check syntax
or conventions.
Master glossary
---------------
When you add a new entry to the glossary, it is highly recommended to add
the entry to the master glossary ``i18n/locale/i18n.pot``.
By doing this, all language teams can share the glossary.
The master glossary is an usual POT file.
You can edit it in your favorite editor as usual.
After you edit the master glossary, ensure to reflect the change
to all language glossary files. To do this, run the following command.
.. code-block:: console
tox -e venv python setup.py update_catalog
Finally, propose a patch including all of the above changes to
the Gerrit review system.

1
doc/source/index.rst
View File

@ -25,6 +25,7 @@ Contents
create_lang_team
check_translation
translation_tips
glossary
translation_stats
i18n_team_meeting
infra