[Openstack-docs] Translating API ref

Anne Gentle annegentle at justwriteclick.com
Tue Dec 31 04:00:41 UTC 2013


All sounds right to me, including Andreas's head start on step 0.




On Mon, Dec 30, 2013 at 8:34 AM, Andreas Jaeger <aj at suse.com> wrote:

> On 12/30/2013 02:37 PM, Tom Fifield wrote:
> > Hi all,
> >
> > I've been contacted by someone who might have resources to do some
> > translation of the api reference. However, I'm not 100% clear on the
> > tooling changes required.
> >
> > It looks like we need to
> >
> > 0) change infra, so that openstack-doc-tools is available to jobs in the
> > openstack-api-site repo
>
> Yeah, I'm working on that part and currently are blocked by an infra
> review ( https://review.openstack.org/#/c/62984/ ).
>
> I've also done over the last days quite some changes to
> openstack-doc-tools so that it can gate the api-site repo.
>
> Reviews are welcome:
>
> https://review.openstack.org/#/q/status:open+project:openstack/openstack-doc-tools,n,z
>
> Thanks,
> Andreas
>
> > 1) make openstack-doc-tools/bin/generatepot work with the WADL format,
> > if it doesn't already
>

One thought here is that the text that would be translated may already be
in the docbook markup, so hopefully there won't be much work to do here.


> > 2) change infra, so that changes to openstack-api-site are propogated to
> > the translation system, like they are already for openstack-manuals
> >
> > did I miss anything?
>

One additional thought is that the html output for api-ref.html hasn't had
any translation consideration at all for wrapping, text size, fonts, and so
on. Also, it's possible that the table titles are encoded in the xslts
themselves. Diane and David may know more.

Also, one last thought, I'd like to know more about the reason for
prioritizing an API reference so highly? I thought that other translation
efforts hadn't prioritized API info as high as other items, so I'm curious
about the audience and their need. If they're SDK devs that's great. Or if
user guides and other guides are already done and they're looking for more
to translate, that's cool too. Just want to know more background if you can
share.
Anne

Anne


> >
> >
> >
> > Regards,
> >
> >
> > Tom
> >
> > _______________________________________________
> > Openstack-docs mailing list
> > Openstack-docs at lists.openstack.org
> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
> >
>
>
> --
>  Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
>   SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
>    GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (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
>



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


More information about the Openstack-docs mailing list