- OpenStack-I18n - lists.openstack.org

Install Guide translation
by KATO Tomoyuki 04 Dec '15

04 Dec '15

Hi team, especially Czech member, Just a reminder. As mentioned a days ago, the translation resource of Install Guide for Liberty is "stable-liberty" version at Zanata. "master" version is a draft for Mitaka. Also, to be honest, the guide may be heavily rewrited for Mitaka. Regards, KATO Tomoyuki > On 2015-11-17 10:49, Ying Chun Guo wrote: > > Hi, Andreas > > > > I see stable/liberty is created in the repo of openstack-manuals, > > and stable-liberty version is created for openstack-manuals project in > > Zanata. > > Thank you for handling these. > > > > Is the installation guide in the master branch keeping open for Mitaka > > release? > > Yes. > > > So in order to translate Liberty installation guide, our translators should > > go to stable-liberty and work there. > > Correct. > > > I have changed the link of openstack manuals in the home page > > translation plan > > to stable-liberty version. > > Correct me if I'm wrong. > > Looks fine > > Andreas

1 0

Re: [Openstack-i18n] Chinese (zh_CN) translations are broken
by Andreas Jaeger 03 Dec '15

03 Dec '15

On 2015-12-03 09:43, Ying Chun Guo wrote: > Thank you, Andreas. > > Could you tell me what are source strings of the bad translations? > I will take a look and investigate the history. For liberty, it was all strings of the form "`Bugs: OpenStack Block Storage (cinder) <https://bugs.launchpad.net/cinder>`__" Andreas -- Andreas Jaeger aj(a){suse.com,opensuse.org} Twitter: jaegerandi SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany GF: Felix Imendörffer, Jane Smithard, Graham Norton, HRB 21284 (AG Nürnberg) GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126

3 2

Re: [Openstack-i18n] [OpenStack-docs] Usage of custom RST directives
by Lana Brindley 03 Dec '15

03 Dec '15

-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA256 How will it impact translation? L On 02/12/15 23:21, Mariia Zlatkova wrote: >> >> At the moment I am not sure if I like it or not. But I think the usage of >> custom RST directives should be discussed on the list and if we decide to >> use custom RST directives they should be documented in the contributor >> guide. >> > > I think it makes sense to add this directive to the Contributor Guide (not > to copy and paste files to the repository and then update them manually). > > Maria > > On Wed, Dec 2, 2015 at 2:45 PM, Olena Logvinova <ologvinova(a)mirantis.com> > wrote: > >> At the moment I am not sure if I like it or not. But I think the >>> usage of custom RST directives should be discussed on the list and if >>> we decide to use custom RST directives they should be documented in >>> the contributor guide. >> >> >> I like the way a document looks like if we use this directive - it becomes >> smaller and, therefore, looks nicer. =) >> So I vote for adding this directive to the Contributor Guide conventions. >> >> Thanks >> Olena >> >> On Wed, Dec 2, 2015 at 1:17 PM, Gauvain Pocentek < >> gauvain.pocentek(a)objectif-libre.com> wrote: >> >>> Le 2015-12-02 11:31, Christian Berendt a écrit : >>> >>>> Hello everybody. >>>> >>>> While reviewing a review request for the new config-rst-guide I saw >>>> the usage of the RST directive "remote-code-block". I never saw this >>>> directive before and after searching for the definition I only found >>>> >>>> https://github.com/openstack/openstack-manuals/blob/master/doc/config-ref-r… >>>> . >>>> >>> >>> This particular directive tries to reproduce the docbook <xi:include> >>> behaviour, to avoid adding loads of sample file in our tree. I'm guilty of >>> adding it to the config-ref-rst folder. >>> >>> >>>> At the moment I am not sure if I like it or not. But I think the >>>> usage of custom RST directives should be discussed on the list and if >>>> we decide to use custom RST directives they should be documented in >>>> the contributor guide. >>>> >>> >>> Agreed. To be honnest I planned to write to the ML but it just slipped my >>> mind. >>> >>> >>> Gauvain Pocentek >>> >>> Objectif Libre - Infrastructure et Formations Linux >>> http://www.objectif-libre.com >>> >>> >>> _______________________________________________ >>> OpenStack-docs mailing list >>> OpenStack-docs(a)lists.openstack.org >>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs >>> >> >> >> >> -- >> Best regards, >> Olena Logvinova, >> Technical Writer | Mirantis, Kharkiv | 38, Lenin av., Kharkiv >> ologvinova(a)mirantis.com | +380950903196 >> >> _______________________________________________ >> OpenStack-docs mailing list >> OpenStack-docs(a)lists.openstack.org >> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs >> >> > > > > > _______________________________________________ > OpenStack-docs mailing list > OpenStack-docs(a)lists.openstack.org > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs > - -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com -----BEGIN PGP SIGNATURE----- Version: GnuPG v2 Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/ iQEcBAEBCAAGBQJWX3PhAAoJELppzVb4+KUyD5IIAI78AYaDM00xzv1rmSyd7Pg1 3p0NrvZD2BtLPEiCq42B5DRWf2XNNnzbFGyqWvyT8ShD/94pr+5ASGceKv5t8P7H Rn0Gkc6idGKsv53ZKxWRHwizCm8mt+3VPiOQYZYhK4ghFII/mBY8kYNwnRQyyYHv rU5tdLNqOAlq36WqmVVbOUh0C3Rf3+YPs3BjcWNnnqVx11C/tPYJ5LR7oNHxW3jJ ZP0wZe9i/+6yOtH5dDxj0k4WnwXvdfXQPIAlHbpY1FvJUl8vsRMxrEe7s10AmpTS D2UybNqPg79PBdg7CUX6c72r+ASPw+LZTJeJm3vVpWY4izpmezZWt30drEUIgkU= =gnC5 -----END PGP SIGNATURE-----

2 1

IRC meeting tomorrow
by Ying Chun Guo 02 Dec '15

02 Dec '15

Hello, team We will have IRC meeting tomorrow at 0600 UTC in the IRC channel #openstack-meeting. I'm going to cover following topics tomorrow. * Discussion: Bug management process in Launchpad * Discussion: Glossary management process * Open discussions If you have more topics, please propose freely. Best regards Ying Chun Guo (Daisy)

1 0

Re: [Openstack-i18n] [OpenStack-docs] [openstack-dev] DocImpact Changes
by Lana Brindley 02 Dec '15

02 Dec '15

-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA256 On 02/12/15 12:53, Armando M. wrote: > On 24 November 2015 at 13:11, Lana Brindley <openstack(a)lanabrindley.com> > wrote: > > Hi Akihiro, > > Judging by most of the bugs we see in the openstack-manuals queue, the > bugs that will be raised in projects' own queues will usually be against > their own developer documentation. > > >> I am a bit confused. The developer documentation coexists with the code >> that's being patched. Is this the documentation you're referring to? So for >> instance in Neutron we have [1] rendered into [2]. That's correct. > >> I always assumed that DocImpact was needed to flag configuration changes, >> and more generally user facing issues, and these are not captured in the >> developer doc [2] (afaik, *-aas services do have a developer documentation >> but no entry point in [4]), as developers are not the audience, but rather >> guide [3]. On the other hand, if patches do require dev doc changes (like >> design issues etc), reviewers tend to ask to take care of them in the >> context of the same patch, without the burden of going through an extra bug >> report. I agree, and that was the original intention, however it doesn't get used that way in the majority of cases we see. Feel free to use DocImpact (with a description), and then manually flip the bug to openstack-manuals in this case. > >> So the fact that Neutron's DocImpact changes raises a bug report in LP >> Neutron seems counterintuitive, and I am a bit at loss here. Can you >> elaborate on what was the rationale for making only certain projects target >> their own queues? I wouldn't want to have bug reports be reassigned to the >> right queue only to cause more burden that this initiative originally >> intended to relieve. We chose the five 'defcore' projects here, as they are the ones that are formally (and most extensively) documented in openstack-manuals. > >> Having said that, let's assume we are stricter about what gets flagged with >> DocImpact, would you be open to revisiting the doc group for Neutron as set >> in [5]? In the meantime, I'll go ahead and look at the outstanding patches >> and bug reports recently filed to sanitize with the best of my abilities. As we noted in the original spec, we appreciate that Neutron is on the cusp of being considered 'defcore', and we're happy to include it once that has happened formally. Thanks for your help. Lana - -- Lana Brindley Technical Writer Rackspace Cloud Builders Australia http://lanabrindley.com -----BEGIN PGP SIGNATURE----- Version: GnuPG v2 Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/ iQEcBAEBCAAGBQJWXmDwAAoJELppzVb4+KUyezMH/3WuKrW+8Py9XU3o2vddCK4c ZovehU0Xq1mHzzpfh8Vfc71MfJVAtotr9Lt0Vd5b4jAnjSWz7QI4/W2CG3d+aM+L FYPDn9koTC/+EsXlz8ekzLQUz6PToa21jfdmcg6tSAPA09FV5j7SPWIPXD9bvzun q9NWhs3jjj4hVtgUhmFdeC7B0vDzT6EWU2kAuSWwUEf7z2c3S7ZnuteyOKLf6aLZ rRbZi59ras8/3jI9EY8h6Wk47gQ3fLwvYyL/tHU9c2jOGPPz47f7HKaXVO0MQ58p E4V3nhGEITt3NMQH8m0IEW7JLd3tRX1C7ERKK05+k5yl7dirxKsysq52xJh0EMo= =1mW1 -----END PGP SIGNATURE-----

1 0

Translation warnings (Re: [OpenStack-docs] Code block in RST and translation)
by Akihiro Motoki 01 Dec '15

01 Dec '15

2015-11-25 23:54 GMT+09:00 Andreas Jaeger <aj(a)suse.com>: > On 2015-11-25 15:48, KATO Tomoyuki wrote: >>> >>> >>>> On 25 Nov 2015, at 03:41, KATO Tomoyuki <tomo(a)dream.daynight.jp> wrote: >>>> >>>>> My idea at now is to use "code-block" directive as possible as we can, >>>> >>>> >>>> As far as I know, docs team guides mainly use "code-block". >>>> So, I'm okay to unify to "code-block" directive. >>>> >>>>> but I am not sure it is the right direction as "::" is widely used. >>>> >>>> >>>> In my understand, most of developers like “::”, which is simple RST >>>> format :) >>> >>> >>> Maybe we could add a gate check that looks for “::” in the end of the >>> strings (original and translated)? It would enable developers to use >>> whatever they are used to. >> >> >> Nice idea! Sounds good to me, as a non-vote job. >> >> Regards, >> KATO Tomoyuki > > > But who will monitor this and correct it? > > We already see warnings in translated code that everybody ignores, let's > find a good way to monitor and fix these problems first before we add > more tests... I think this kind tests are categorized into two: (a) to detect anti-patterns which are not good for translations. (b) to detect warnings when building translation documents. I have no good idea on who monitors it. (b) can be a periodic job and language translators need to check them. Related to (b) warnings in translation documents, I cleaned up warnings in Japanese translations last night. At now, Japanese documents have no warnings except https://bugs.launchpad.net/openstack-manuals/+bug/1521473. Most of them can be fixed by - adding an extra white space after closing RST markups such as `` or **, or - removing extra white spaces at beginning or end of strings wrapped by RST markups. Even with these warnings, translated documents are rendered properly. On the other hand, some warnings are actually due to translation mistakes to be fixed. This turns out that checking warnings is still important. Akihiro > > Andreas > -- > Andreas Jaeger aj(a){suse.com,opensuse.org} Twitter: jaegerandi > SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany > GF: Felix Imendörffer, Jane Smithard, Graham Norton, > HRB 21284 (AG Nürnberg) > GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126 > > > > _______________________________________________ > Openstack-i18n mailing list > Openstack-i18n(a)lists.openstack.org > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-i18n

2 1

Upstream Training material publication
by KATO Tomoyuki 01 Dec '15

01 Dec '15

Hi team, Happily, we have new translation feature for Upstream Training material. Also, translation publication job is enabled at now. For ONLY this guide, the translated guide is published immediately. Amazingly, Korean team has almost finished translation. Congrats! http://docs.openstack.org/ko_KR/upstream-training/ Regards, KATO Tomoyuki

2 1

external reference in RST and translation
by Akihiro Motoki 27 Nov '15

27 Nov '15

Hi, It is about RST formatting and translation, again. I had a trouble in translating the following type of external references. The following style is used especially when the same reference is used multiple times. In this case, translators MUST keep an original label, in this case 'User guide' in English even if there is more appropriate string in each language. If translators translate such strings, we will get a broken external link. I don't have a good solution on this other than keep original strings at now. Any suggestions? (http://docs.openstack.org/contributor-guide/rst-conv/refs.html#external-ref…) ---- Here is an external web link separated from its definition: This paragraph contains the link to `User guide`_. ... .. format the link definition at the end of the file as follows: .. _`User guide`: http://docs.openstack.org/user-guide/ ---- Thanks, Akihiro

1 0

Code block in RST and translation
by Akihiro Motoki 27 Nov '15

27 Nov '15

Hi, According to [1], we use two types of code blocks in RST documentations. The one is to end a line with "::" [2] and the other is to use 'code-block'. During translation, I noticed the first style can be a wrong formatting in translated documents (it will be considered as "block quote" as far as I tested). It is not easy that translators understand "::" at end of line has a special meaning. To keep the format, translators MUST keep "::" at the end of line, but ":" is rarely used in some languages and I think they will forget "::" easily. In addition, it is hard to detect this kind of things during translation reviews. Note that other RST conventions are easier to be recognized as special because they are very different from usual strings. On the other hand, ending a line with "::" is a standard ReST convention and it is widely used in writing documents in ReST format. My idea at now is to use "code-block" directive as possible as we can, but I am not sure it is the right direction as "::" is widely used. Thought? Thanks, Akihiro [1] http://docs.openstack.org/contributor-guide/rst-conv/source-code.html [2] http://docs.openstack.org/contributor-guide/rst-conv/source-code.html#stand… [3] http://docs.openstack.org/contributor-guide/index.html#search-in-this-guide

4 6

Arch Design Guide RST conversion finished
by KATO Tomoyuki 27 Nov '15

27 Nov '15

Hi team, Docs team finished Arch Design Guide RST conversion. At now, new RST translation resource is uploaded to Zanata. openstack-manuals / arch-design (same name) Best Regards, KATO Tomoyuki

1 0