From 943e3100214446091b65e00ae868a745b6ff0ecc Mon Sep 17 00:00:00 2001 From: "Ian Y. Choi" Date: Sun, 18 Feb 2024 01:49:19 +0900 Subject: [PATCH] [doc] Add explanation for project doc i18n setup - 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 --- doc/source/project_setup.rst | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/doc/source/project_setup.rst b/doc/source/project_setup.rst index 2de5b3b..9bd8ab5 100644 --- a/doc/source/project_setup.rst +++ b/doc/source/project_setup.rst @@ -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 `_ +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 `_ +translation infrastructure script file.