[OpenStack-I18n] [OpenStack-docs] Summary of how I18n affects with doc-migration

Doug Hellmann doug at doughellmann.com
Tue Aug 1 15:43:34 UTC 2017

[resending to the lists]

> On Aug 1, 2017, at 10:55 AM, Doug Hellmann <doug at doughellmann.com> wrote:
> Excerpts from Andreas Jaeger's message of 2017-08-01 08:57:09 +0200:
>> On 2017-07-31 22:46, Doug Hellmann wrote:
>>> Excerpts from Ian Y. Choi's message of 2017-08-01 03:16:09 +0900:
>>>> [...]
>>>> 2. Draft index page for translated documents was also removed
>>>> Previously, Docs team maintained draft documents for the master branch 
>>>> (which will be the stable branch
>>>> after the official release and the document stables) on 
>>>> https://docs.openstack.org/draft/draft-index.html page.
>>>> It also contained translated draft documents and I18n team accessed the 
>>>> page to see whether translated documents
>>>> render well or not, and also review translated strings.
>>>> I did not notice when I saw the spec [1], but recently, I noticed that 
>>>> the the draft-index.html page was deprecated
>>>> by [next-release-name]/index.haml (e.g., 
>>>> https://docs.openstack.org/pike/index.html ) [4].
>>>> Since I18n team encourages translation review for the better quality of 
>>>> translations, it is a good idea to see
>>>> draft documents before language landing pages have the link to fully 
>>>> translated and reviewed documents.
>>> Is it possible to see the draft of a translation by reviewing the
>>> output of the job that proposes the patch containing the translated
>>> text?
>> Currently not, it needs publishing to docs-draft and a way to access the
>> multiple documents. Note this needs handling for both openstack-manuals
>> and project repos like neutron (networking-guide).
> Could we make it work that way? I understand why we need a separate
> review step for the translations, but not why we need a separate
> copy of the docs published outside of the context of a job in order
> to perform that review. (This is probably just me not understanding
> how a tool works.)
>>>> Motoki-san proposed an idea of translation status support using an yaml 
>>>> file in openstack-manuals [5],
>>>> and I would like to discuss with I18n team how we deal with the change 
>>>> of draft index page.
>>> How would that flag or information be used?
>> WE could just have the link to it added - dependent on the flag - to either:
>> * language index
>> * draft index
> It seems like we want a list of languages for which there are
> translations for a given set of docs. We could use that to populate
> templates in a few different ways (link from the English version
> to the other languages, link from a $language landing page to all
> of the guides in that language, etc.).
> I can advise someone on how to add those features, if we have a
> volunteer.
> Doug

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-i18n/attachments/20170801/1db4b31d/attachment.html>

More information about the OpenStack-I18n mailing list