Open Stack

On Thu, Apr 16, 2015 at 4:42 AM, Ying Chun Guo <guoyingc at cn.ibm.com> wrote:

> Hello,
>
> There was a meeting with translators in IRC.
> Andreas Jaeger and Lana Brindley from doc team attended.
> François Bureau from French team, SungJin Kang from Korean team
> and myself from Chinese team attended the meeting.
>
> Firstly, Andreas confirmed that the tool chain was extendable.
> The preprocessing of po/pot before translation could be implemented in
> tools/generatepot-rst.sh.
> The postprocessing of po after translation could be done either as part of
> the building process,
> or as part of the infra scripts - propose_translation_update_manuals.sh .
>
> Then we talked about how to translate those strings with rst markups.
> rst markups are more difficult to identified than XML tags.
> That's why a translators RST cheat sheet is needed.
> Andreas and Lana explained some markups to translators.
> At last, all the attendees from translation teams were fine with the rst
> conversion.
>
> I will continue to maintain the translators cheat sheet.
> If doc writers introduce new mark ups, don't forget to add to the cheat
> sheet.
> The sheet can help the new translators easily understand how to translate.
>
> I think we got the agreement to go on.
> Many thanks to the attendees.
>
>
Wonderful news, thanks to everyone who worked through it together.

I love the wiki "cheat sheet" and will be using it myself often. Thank you
Olga for identifying additions, please put them on the wiki page for us all
to use.

For next steps, I'd like to have the RST guide published prior to our last
bug day for Kilo.

Our remaining tasks are on the wiki page at:
https://wiki.openstack.org/wiki/Documentation/Migrate#Publishing_User_Guides

Andreas, does the 17th (tomorrow) work for you? These are the remaining
steps for publishing:

Remove doc/user-guide, doc/user-guide-admin, doc/hot-guide/ directories
(ajaeger)
Publish new User Guides to proper place (ajaeger)
Update entries to index.html pages pointing to new content (annegentle)
Update sitemap.xml (annegentle)
Add redirects for moved pages removing extra /content/ directory
(annegentle)

If you see anything is incorrect (or impossible), please let us know. I
really need to wrap my head around the redirects now. :)

Really appreciate the cross-team collaboration.
Thanks,
Anne

> Best regards
> Ying Chun Guo (Daisy)
>
>
> Ying Chun Guo/China/IBM at IBMCN wrote on 2015/04/10 17:04:38:
>
> > From: Ying Chun Guo/China/IBM at IBMCN
> > To: Andreas Jaeger <aj at suse.com>
> > Cc: "openstack-i18n at lists.openstack.org" <openstack-
> > i18n at lists.openstack.org>, "openstack-docs at lists.openstack.org"
> > <openstack-docs at lists.openstack.org>
> > Date: 2015/04/10 17:09
>
> > Subject: Re: [OpenStack-docs] [Openstack-i18n] Status of the RST
> > Documentation Toolchain
> >
> > Here are my thoughts.
> >
> > 1. I would like the toolchain could be extendable for the future
> improvement.
> > If we are able to make small and easy improvements before publishing,
> > like handling double stars and double colons (described in [1]),
> > let's do that.
> > In the future, let's continue the improvement. The goal is to provide an
> > easily understandable source strings for translators.
> >
> > 2. I would like the translators to be well educated about the RST
> markups.
> > I will covert [2] into translators' view.
> > ( I don't think translators would read through this long document to
> > pick out RST markups. )
> > Clearly list RST markups, give samples, and describe the meanings.
> > Thus the translators could easily understand which words and
> > punctuation characters
> > should not be translated and need to keep them unchanged carefully.
> >
> > 3. Next Thursday, I will have the team meeting with the translators. I
> will
> > collect their feedback to these RST markups.
> >
> > @ Andreas and Anne, let me know your feeling tho these thoughts.
> >
> > Daisy
> >
> > [1]
> http://lists.openstack.org/pipermail/openstack-i18n/2015-April/001030.html
> > [2] https://wiki.openstack.org/wiki/Documentation/Markup_conventions
> >
> > Andreas Jaeger <aj at suse.com> wrote on 2015/04/10 12:38:21:
> >
> > > From: Andreas Jaeger <aj at suse.com>
> > > To: Ying Chun Guo/China/IBM at IBMCN
> > > Cc: "openstack-i18n at lists.openstack.org" <openstack-
> > > i18n at lists.openstack.org>, "openstack-docs at lists.openstack.org"
> > > <openstack-docs at lists.openstack.org>
> > > Date: 2015/04/10 12:38
> > > Subject: Re: [OpenStack-docs] [Openstack-i18n] Status of the RST
> > > Documentation Toolchain
> > >
> > > On 04/09/2015 02:16 PM, Ying Chun Guo wrote:
> > > > [...]
> > > > I investigated the translation process of RST document, asked by Anne
> > > > and Andreas.
> > > > While I made test, I used playground-user-guide, which was a quite
> new
> > > > document.
> > > > I didn't pay attention to the pot content changes between the old
> > > > version and the new version.
> > > > I'm quite sorry for that.
> > > > I don't want to block anything.
> > > > In my mind, the toolchain could be improved continuously,
> > > > both before publication and after publication.
> > >
> > > With the analysis done by Daisy [1] (thanks!) and my scripted updates
> to
> > > convert automatically what was possible [2] thus raising the number of
> > > translated strings for Japanese on the User Guides from 32 % to 37 %,
> > > and my patch for building the Japanese tools we have IMHO done
> > > everything we can do.
> > >
> > > Or has anybody suggestions for additional things to do now?
> > >
> > > If not, I think we're good to publish the new RST User Guides.
> > >
> > > So, I propose these next steps:
> > > * Get explicit ok by Daisy that we can continue based on her findings
> > > * Review and merge patch [3]
> > > * Anne decides when to publish User Guides
> > >
> > > Andreas
> > >
> > > [1]
> > >
> http://lists.openstack.org/pipermail/openstack-i18n/2015-April/001030.html
> > > [2]
> > >
> http://lists.openstack.org/pipermail/openstack-i18n/2015-April/001034.html
> > > [3] https://review.openstack.org/162424
> > > --
> > >   Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica:
> jaegerandi
> > >    SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
> > >     GF: Felix Imendörffer, Jane Smithard, Jennifer Guild, Dilip
> Upmanyu,
> > >         Graham Norton, HRB 21284 (AG Nürnberg)
> > >      GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272
> A126
> > > _______________________________________________
> > OpenStack-docs mailing list
> > OpenStack-docs at lists.openstack.org
> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>
>
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>
>
>

-- 
Anne Gentle
annegentle at justwriteclick.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20150416/767dbaac/attachment.html>