Can not translate index - OpenStack Installation Guide

[KATO Tomoyuki]

Installation Guide contains index.rst and index-debian.rst as index file a few distributions.
When the tools build Installation Guide, switch index files according to the building distribution.
The message catalog (pot files) is generated from the index for the last distribution.
By current build order, Debian Installation Guide is built last.
Therefore, messages in index-debian.rst is only included, index.rst is not included.

https://github.com/openstack/openstack-manuals/blob/master/doc/install-guide/source/locale/install-guide.pot

Problem:
  1. The messages from index.rst are not included and marked source files.
     So, translation for index is not reflected to Ubuntu/OBS/RDO guides.
  2. If index.rst and index-debian.rst have the different messages,
    the messages only within index.rst do not appear the message catalog.

Solution:
 1.- Unify index.rst and index-debian.rst, and change index switch mechanism.
    or
  2. Concatenate message catalog from index.rst and index-debian.rst.

-----------------------------------
Release: 0.1 on 2015-10-20 02:09
SHA: ab9f724079833e92a17d18af2a869bfe1321a3b7
Source: http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/install-guide/source/index.rst
URL: http://docs.openstack.org/draft/ja/install-guide-ubuntu/

[Andreas Jaeger (jaegerandi)]

Idea was to keep those two files completely in sync so that any content that is in one file, gets translated when building the other. That's why there's at the top of the file a note asking to keep them in sync. If those two are not in sync, let's fix that...

[Andreas Jaeger (jaegerandi)]

I've send a patch for Install Guide, hope that's fine...

[KATO Tomoyuki (kato-tomoyuki)]

According to investigation by Japanese team, keeping contents consistency is not sufficient to this situation.

For example, index.rst and index-debian.rst have the same string "OpenStack Installation Guide for Ubuntu",
and this strings is translated into Japanese [1]. But, the output is not translated [2].
On the other hand, translation on index-debian.rst [3] is reflacted to the output [4].
The file index-guide.pot has the messages "marked" from index-debian.rst [5].
So, we guess Sphinx don't use these messages to index.rst.

[1] https://github.com/openstack/openstack-manuals/blob/master/doc/install-guide/source/locale/ja/LC_MESSAGES/install-guide.po#L3658L3659
[2] http://docs.openstack.org/draft/ja/install-guide-ubuntu/
[3] https://github.com/openstack/openstack-manuals/blob/master/doc/install-guide/source/locale/ja/LC_MESSAGES/install-guide.po#L3650L3651
[4] http://docs.openstack.org/draft/ja/install-guide-debian/
[5] https://github.com/openstack/openstack-manuals/blob/master/doc/install-guide/source/locale/install-guide.pot#L3377

[Andreas Jaeger (jaegerandi)]

That's sad ;( Thanks for further investigation.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/237401
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=2b6e8335f6d6401c22c1db705bdecd0d5ea5af06
Submitter: Jenkins
Branch: master

commit 2b6e8335f6d6401c22c1db705bdecd0d5ea5af06
Author: Andreas Jaeger <email address hidden>
Date: Tue Oct 20 07:43:33 2015 +0200

    Install Guide: Sync index files

    For translation, these two files need to be kept in sync. Sync last
    change over.

    Partial-Bug: #1507861
    Change-Id: I4625a9eaef7b855bbb1b613a3c12fd3752c85452

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/237885

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/237885
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=e04033dec1146548d44d5af6772ba05c21ec5083
Submitter: Jenkins
Branch: master

commit e04033dec1146548d44d5af6772ba05c21ec5083
Author: KATO Tomoyuki <email address hidden>
Date: Wed Oct 21 14:13:28 2015 +0900

    Rework install guide build tool

    We have two index files for Debian and other distributions.
    On the other hand, when the tool generates translation resources,
    uses only one index file, Debian index as of now.
    Therefore, translation for index files is applied
    to only one index file.
    For example, Translation for Ubuntu index file
    are not applied for Ubuntu Installation Guide.

    * Unify index files into one file
    * Process toctree for each distribution dynamically

    Change-Id: I3abcd7da3569bb8e9edbc02574dcb74c12752ede
    Closes-Bug: #1507861

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/openstack-manuals 15.0.0 release.