openstack/i18n
Code Issues Proposed changes

[doc] Add explanation for project doc i18n setup

Browse Source 
- Add explanation as note that Zanata project needs to be created
  before tranlation setup
- The doc section was migrated from OpenStack project creators guide
  so mention the purpose of the section as note
- Add how to enable project documentation translation

Change-Id: I13599548117be85a5ab0a0c98b0bbc9bc23724e1
This commit is contained in:
Ian Y. Choi 2024-02-18 01:49:19 +09:00
parent 84b571f65c
commit 943e310021
1 changed files with 21 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
doc/source/project_setup.rst
View File

@ -1,8 +1,14 @@
===================================
Enabling Translation Infrastructure
===================================
=============================================================
Project Repository Setup to Enable Translation Infrastructure
=============================================================
Once you have your project set up, you might want to enable
.. note:: This document was moved from OpenStack Project Creators Guide
who want to enable translation infrastructure for their project.
Before proceeding, target translation project with corresponding
versions (master and stable branches) should be created on Zanata
and I18n team will help with this.
Once you have your project repository set up, you might want to enable
translations. For this, you first need to mark all strings so that
they can be localized, for Python projects use `oslo.i18n`_ for this
and follow the `guidelines`_.
@ -210,3 +216,14 @@ exist, it is interpreted that there are no such modules.
You also need to setup your repository following the instruction
for Python and/or Django project above appropriately.
Project Documentation Translation
---------------------------------
Documents on the project following with
`OpenStack documentation structure <https://docs.openstack.org/doc-contrib-guide/project-guides.html>`_
can be translated into multiple languages.
List of project repositories for documentation translation is maintained
in the ``DOC_TARGETS`` variable within
`common_translation_update.sh <https://opendev.org/openstack/openstack-zuul-jobs/src/branch/master/roles/prepare-zanata-client/files/common_translation_update.sh>`_
translation infrastructure script file.