Merge "Add doc on how to report and handle translation bugs"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
06040638bd
|
|
@ -0,0 +1,55 @@
|
|||
Reporting translation bugs
|
||||
==========================
|
||||
|
||||
This page describes how end users can report translation bugs.
|
||||
|
||||
Finding and reporting translation bugs is an important step towards better
|
||||
quality of translations in OpenStack.
|
||||
|
||||
When you are using OpenStack (including the dashboard, API or CLI) or are
|
||||
reading translated documentations, if you find something wrong, something you
|
||||
cannot understand, something you cannot agree, or something to be improved,
|
||||
please consider reporting it.
|
||||
|
||||
Where can I report a bug?
|
||||
-------------------------
|
||||
|
||||
OpenStack I18n team uses
|
||||
`Launchpad <https://bugs.launchpad.net/openstack-i18n>`_
|
||||
for the bug tracking.
|
||||
|
||||
Translation bugs in all languages can be reported here.
|
||||
|
||||
How can I report a bug?
|
||||
-----------------------
|
||||
|
||||
If you visit `openstack-i18n launchpad <https://bugs.launchpad.net/openstack-i18n>`_,
|
||||
we can find **Report a bug** at the right-upper corner. Click to report a bug.
|
||||
|
||||
You can report a bug in your language (or English).
|
||||
|
||||
It is highly recommended to include the following information.
|
||||
|
||||
* Where you find a bug you are reporting?
|
||||
|
||||
* For documentations, URL and a detail place would be great.
|
||||
* For the dashboard, panel or form name.
|
||||
|
||||
* What is wrong? What should be improved?
|
||||
* **Make sure to include your English language name in a bug summary**.
|
||||
It is also suggested to write a bug summary in English.
|
||||
For example:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
[japanese] Dashboard action in the Instance table is not translated
|
||||
|
||||
* (optional) Put your language name as bug tag.
|
||||
|
||||
Who can help you?
|
||||
-----------------
|
||||
|
||||
Everyone in the OpenStack community is glad to help you.
|
||||
|
||||
* `Language translation team <https://wiki.openstack.org/wiki/I18nTeam/team>`_: you can ask in your language :-)
|
||||
* OpenStack I18n team: See :ref:`label-i18n-team-contact`
|
||||
|
|
@ -24,9 +24,7 @@ If you have questions, you can contact your coordinators.
|
|||
If you cannot find your local team,
|
||||
you can request to :doc:`create a local translation team <create_lang_team>`.
|
||||
|
||||
To report translation errors,
|
||||
go to `openstack-i18n in Launchpad`_ and report bugs.
|
||||
Mark bugs with a tag "translation".
|
||||
To report translation errors, see :doc:`bug_report`.
|
||||
|
||||
There are three different roles in a translation team:
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,51 @@
|
|||
=========================
|
||||
Handling translation bugs
|
||||
=========================
|
||||
|
||||
If you are a translator or a person involved in I18n effort,
|
||||
you may be interested in fixing translation bugs :)
|
||||
|
||||
Bugs in translated documents or dashboard are mainly classified into
|
||||
the following areas:
|
||||
|
||||
* translation bugs
|
||||
* bugs in original strings
|
||||
* bugs in tool chains
|
||||
|
||||
Translation bugs
|
||||
----------------
|
||||
|
||||
Visit a corresponding resource in Zanata and correct translations.
|
||||
|
||||
.. note::
|
||||
|
||||
As a translator, if reported bugs turns out beyond a translation bug, it is
|
||||
better to ask I18n team members via the mailing list or the IRC channel.
|
||||
They can handle such bugs.
|
||||
|
||||
Bugs in original strings
|
||||
------------------------
|
||||
|
||||
If a reported bug turns out that an original string or message is not correct,
|
||||
we suggest to file a bug to a corresponding OpenStack project.
|
||||
In most cases, a related project would be one of:
|
||||
|
||||
* `OpenStack manuals <https://bugs.launchpad.net/openstack-manuals>`_
|
||||
* `Horizon (OpenStack dashboard) <https://bugs.launchpad.net/horizon>`_
|
||||
|
||||
.. note::
|
||||
|
||||
During translation you may sometimes encounter strings which are hard to
|
||||
translate in your language. For example, we cannot control the order of
|
||||
words, or a plural form is not supported. Usually, this kind of bugs cannot
|
||||
be fixed just by changing the strings and more work is needed. We would
|
||||
also suggest to file a bug to a corresponding project above. In this case,
|
||||
ensure to add **i18n** tag when filing a bug.
|
||||
|
||||
Bugs in tool chains
|
||||
-------------------
|
||||
|
||||
If you encounter more complicated things including translation tool chains or
|
||||
something others, the most recommended way is to ask it in the I18n mailing
|
||||
list ``openstack-i18n@lists.openstack.org``.
|
||||
Of course you can file a bug against a related project directly.
|
||||
|
|
@ -19,9 +19,13 @@ Contents
|
|||
:maxdepth: 2
|
||||
|
||||
contributing
|
||||
bug_report
|
||||
handling_bugs
|
||||
official_translator
|
||||
create_lang_team
|
||||
|
||||
.. _label-i18n-team-contact:
|
||||
|
||||
Getting in touch
|
||||
----------------
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue