You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@cloudstack.apache.org by sebgoa <ru...@gmail.com> on 2014/03/05 17:29:57 UTC

[TRANSLATION] Update on new doc format

Hi translators,

It's been a while since we had an update on the translation work.
I am happy to say that 82 people have contributed translations to the cloudstack documentation.

Since we had an update, the transifex site has changed quite a bit, so if you have not looked at it lately, please do.

The big item that we have coming is a change of format for the documentation.

As you know publican was using docbook xml format, this worked well for translation but building and serving these translated docs on the web was a bit of a pain.

On the dev list we have discussed changing the doc format to restructured text (a simple markdown like format), and using read the docs (https://readthedocs.org) to build and host the documentation [1]. For example see [2]. 

Note that this is still a work in progress and anyone is welcome to contribute, all the docs repo are now mirrored on github and we can accept pull requests.

This move is going to mean some changes for translations:

We are still using transifex, but we will now use sphinx-intl [3] to manage the pot and po files . All resource files (.pot) will be updated to transifex in new projects since the restructured text format will generate new strings.

I am still working on this, but I am hoping we can re-use all strings already translated and migrate them to the new project. I am just not sure yet how this is going to work out, so I wanted to inform everyone and ask for help and eyes on this.

To get started I setup a new transifex project for the release notes [4]

I would like to ask folks who have already submitted translation to look at this new project and see how they can access already translated strings and migrate them over to this new project.

The end result in RTD will be a much better experience for localization and better browser support.

Thanks for your help on this, I know it's going to be a challenge,

Cheers,

[1] http://markmail.org/thread/r5sun6m6qyabmffy
[2] http://markmail.org/thread/m235qyxsswhag47i 
[3] http://sphinx-doc.org/latest/intl.html
[4] https://www.transifex.com/projects/p/apache-cloudstack-release-notes-rtd/

-Sebastien