Calling all translators!

[James Roper]

Over the past year we've done a lot of work on the Play documentation to extract code snippets out into compiled and tested source files, creating a special markdown syntax for doing so, and building the infrastructure necessary to serve and validate this documentation.  The primary goal of this is clear, to ensure the quality of the code snippets in the documentation, both now, and as things in Play framework change.

But a secondary goal, and something that we've had in the back of our minds as we've built the infrastructure to do this, is to allow high quality community maintained translations of the documentation.  One problem with community maintained translations is that they very quickly get out of date.  But we think that by providing shared code snippets, we can make it very easy for the community to first of all translate, and secondly maintain the translations of the documentation.

So we have finally got to a point where we are able to offer this - in the form of an SBT plugin that is designed to assist translators in translating and maintaining the Play docs:

http://www.playframework.com/documentation/2.4.x/Translations

So far, we are yet to actually provide the infrastructure on playframework.com to serve community translations, this is because we don't yet have any translations to serve.  But as soon as translations are provided, we will do this.

Over time we hope to improve the SBT plugin, to provide more validations, and also to provide tooling such as the ability to diff the original version of a particular page from one version to the next, so that translators can easily see what has changed and what they need to update.

So if you're interested in providing a translation of the Play documentation, then this is your opportunity!  If you are willing to translate, then I would suggest joining the dev mailing list and replying to this message there (it's been cross posted to both the user and dev mailing list), to coordinate with other people interested in translating to the same language.

--

James Roper
Software Engineer

Typesafe – Build reactive apps!
Twitter: @jroper

[Olivier NOUGUIER]

Hi,

 I can provide French translation.

Regards,

Olivier

--
You received this message because you are subscribed to the Google Groups "Play framework dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to play-framework-...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

--
"Computers are useless. They can only give you answers."
- Pablo Picasso -

[esfandiar amirrahimi]

Hi

I can provide Persian(Farsi) translations.

Best regards,

Esfandiar

[garbagetown]

Hi James,

What a great news is this!

Of course we can provide the Japanese translations.

Best regards,

Yuichiro Umezawa @garbagetown

2014年6月30日月曜日 9時23分13秒 UTC+9 james...@typesafe.com:

[Sangcheol Hwang]

Hi James.

I willing to provide Koran translations.

Force with you.

Sangcheol Hwang

--

You received this message because you are subscribed to the Google Groups "Play framework dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to play-framework-...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

--
Blog: http://pragmaticstory.com
Twiter: @k16wire

[James Roper]

Hey Yuichiro,

I know you already have Japanese translations of some of the older versions in markdown format - happy to work with you to get these on the Play Framework site.

Also, are you intending on still maintaining playframework-ja.org even with if we include the Japanese docs on playframework.com?  If you are, let me know if you need any help with the docs, we can open up our code from playframework.com so that you can reuse that if that would help you.

Cheers,

James

--

You received this message because you are subscribed to the Google Groups "Play framework dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to play-framework-...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Dominik Sienkiewicz]

Hi James

I can help with Polish translations.

Best Regards

Dominik Sienkiewicz

[Stanislav Sobolev]

Hi James. I can provide Russian translation.

[Jacek Królikowski]

Hi!

I would also like to help with the Polish translation. 

Cheers,

Jacek

[Mert Kavi]

Hi James,

We can provide the Turkish translations.

Kind regards,

Mert Kavi

30 Haziran 2014 Pazartesi 03:23:13 UTC+3 tarihinde james...@typesafe.com yazdı:

[Mert Kavi]

Hi again,

We can start now but we can't fetch play-docs-sbt-plugin-2.4.x.

Plugin is avaliable in http://repo.typesafe.com/typesafe/ivy-releases/com.typesafe.play but I guess these versions are daily.

What do you suggest?

Mert Kavi

3 Temmuz 2014 Perşembe 12:19:04 UTC+3 tarihinde Mert Kavi yazdı:

[yuichiro umezawa]

Hi James,

I'm very happy to hear your offer, and I'm very interested in the code of playframework.com.

But I think playframework-ja.org will be enough to redirect the request to playframework.com if you include our translations, so I will deploy a very simple application to do that to playframework-ja.org.

We have been waiting for the chance to provide our translations to playframework.com for four years!

Thanks for your amazing work about Play documentation and this opportunity.

Cheers,

Yuichiro Umezawa

--
yuichiro umezawa

[James Roper]

Hi Mert,

The ".x" in 2.4.x is the version that you choose. Since there's no 2.4 release yet, you'll need to build play locally, then you can use 2.4-SNAPSHOT.

Cheers,

James

--

[Fehmi Can SAGLAM]

Hi James,

Is it OK to translate Play 2.3.1?

Fehmi Can

[James Roper]

Yes, but you'll need to use the Play 2.3.2 or later plugin (not yet released) since that's when the support has been added for this, just tag the repo for Play 2.3.1.

[Fehmi Can Saglam]

Hi James,

We have started translating docs into Turkish. Here is the repo[1].
Should the translations be fully complete before being served on playframework.com?

[1]: https://github.com/PlayFrameworkTR/translation-project

--
Fehmi Can Saglam

On 8 Jul 2014 at 01:54:39, James Roper (ja...@typesafe.com) wrote:
> Yes, but you'll need to use the Play 2.3.2 or later plugin (not yet
> released) since that's when the support has been added for this, just tag
> the repo for Play 2.3.1.
>
>
> On Tue, Jul 8, 2014 at 10:01 AM, Fehmi Can SAGLAM > > wrote:
>
> > Hi James,
> >
> > Is it OK to translate Play 2.3.1?
> >
> > Fehmi Can
> >
> > On 8 Tem 2014, at 00:12, James Roper wrote:
> >
> > Hi Mert,
> >
> > The ".x" in 2.4.x is the version that you choose. Since there's no 2.4
> > release yet, you'll need to build play locally, then you can use
> > 2.4-SNAPSHOT.
> >
> > Cheers,
> >
> > James

> >>>> *James Roper*
> >>>> *Software Engineer*

> >>>>
> >>>> Typesafe – Build reactive apps!
> >>>> Twitter: @jroper
> >>>>
> >>> --
> >> You received this message because you are subscribed to the Google Groups
> >> "Play framework dev" group.
> >> To unsubscribe from this group and stop receiving emails from it, send an
> >> email to play-framework-...@googlegroups.com.
> >> For more options, visit https://groups.google.com/d/optout.
> >>
> > --
> > You received this message because you are subscribed to the Google Groups
> > "Play framework dev" group.
> > To unsubscribe from this group and stop receiving emails from it, send an
> > email to play-framework-...@googlegroups.com.
> > For more options, visit https://groups.google.com/d/optout.
> >
> >
>
>
> --

> *James Roper*
> *Software Engineer*

[Alejandro Luján]

This is great news!

I might be able to help with Spanish. Traveling now, but will get this setup next week.

[James Roper]

Hi Fehmi,

No, we will start serving them as soon as a reasonable start has been made.

Note that we don't yet have the infrastructure on playframework.com to serve these yet - our priorities right now are to get Play 2.4-M1 out so that the community can start playing with dependency injection strategies and give us feedback.  Once that's done, allowing playframework.com to serve docs in different languages will be one of our major focuses.

Cheers,

James

--

James Roper
Software Engineer

[Fehmi Can Saglam]

Thanks James. We have made some progress(about 8%) but still have much to do. 

After finishing the work for DI, we would appreciate support for showing changes in the documentation. 

--
Fehmi Can Saglam

[Taehyun Park]

Hello James,

I can provide Korean translation.

Best,

Taehyun 

[James Roper]

On Thu, Jul 24, 2014 at 8:38 AM, Dominik Dorn <dom...@dominikdorn.com> wrote:

While I'm not a translater, it seems that something with the source examples got messed up, at least here:

http://www.playframework.com/documentation/2.3.x/ThreadPools

Unable to find label async-explicit-ec-imports in source file ../../javaGuide/main/async/code/javaguide/async/controllers/Application.java

Java 8

Unable to find label async-explicit-ec in source file ../../javaGuide/main/async/java8code/java8guide/async/controllers/Application.java

Java

Unable to find label async-explicit-ec in source file ../../javaGuide/main/async/code/javaguide/async/controllers/Application.java

Thanks for reporting this, yes, that's a pretty bad bug, playframework.com serves files out of git, whereas our tests that ensure that all of these code sample references are valid work directly off the filesystem, looks like our git code there is unable to handle parent operators in the path.

Cheers,

Dominik

--
You received this message because you are subscribed to the Google Groups "play-framework" group.
To unsubscribe from this group and stop receiving emails from it, send an email to play-framewor...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

[James Roper]

Hi all,

Play framework documentation translations are now live:

http://playframework.com/documentation

Please have a good look around, and if there are any issues, please let me know.  Also it's the first time I've dealt with HTTP Link headers for translations, if someone that's familiar with them (particularly with how search engines like Google uses them) wants to check them to make sure that they're ok, please do so.

The documentation index, as well as http://playframework.com/documentation/latest, will try and redirect you to the best documentation based on your Accept-Language headers.  These are the only points that do that though, once you are viewing the docs, there is no more language detection.  I'm not sure if that's the best approach or not, in particular, if you get redirected to, for example, the Turkish documentation, the only version of the docs available there is 2.4.x, that may be confusing.  Of course if you switch to English, then you can see every version.

Regards,

James

[池田 尚史]

Sweet! :D

2014年7月28日月曜日、James Roper<ja...@typesafe.com>さんは書きました:

--
You received this message because you are subscribed to the Google Groups "Play framework dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to play-framework-...@googlegroups.com.

[Fehmi Can SAGLAM]

Awesome!

Fehmi Can

--

[Olivier NOUGUIER]

Hi,

  Just started  french translation: https://github.com/cheleb/playframework-fr.

Bye.

[garbagetown]

Hi James,

We've completed to translate 2.2.0 documents at long last, and tagged it as 2.2.0.

- https://github.com/playframework-ja/translation-project/releases/tag/2.2.0

So now we're attempting to translate 2.2.5 and 2.3.5 documents.

At first, we've created 2.2.5 and 2.3.5 branches, and pushed them to our repository.

- https://github.com/playframework-ja/translation-project/tree/2.2.5

- https://github.com/playframework-ja/translation-project/tree/2.3.5

But they are not displayed in "Browse versions" select box on https://www.playframework.com/documentation/ja/2.2.x/Home.

And when I access to https://www.playframework.com/documentation/ja/2.2.5/Home directly, the browser returns "Page not found [Home]" error.

What do I need to do? 

Regards, 

Yuichiro Umezawa

2014年7月28日月曜日 9時17分00秒 UTC+9 James Roper:

[James Roper]

Hey Umezawa-san,

The problem is that 2.2.4/2.2.5/2.3.5 are branches, not tags, and the code we have on playframework.com is filtering all branches that don't match "#.#.x":

https://github.com/playframework/playframework.com/blob/master/app/actors/DocumentationPollingActor.scala#L110

Can you make these branches tags instead?  We could change playframework.com to accept branches that don't have a .x ending but have a number ending instead, but our intention is that once released, the docs for a version are frozen.

Cheers,

James

--

You received this message because you are subscribed to the Google Groups "Play framework dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to play-framework-...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[yuichiro umezawa]

Hi James,

Thank you for your quick reply.

I understand your intention, so we'll translate 2.2.5 docs on 2.2.x branch, and 2.3.5 docs on 2.3.x branch.

Cheers, 

Yuichiro Umezawa

--
yuichiro umezawa

[Thomas Toye]

Hi everyone, I'm having some trouble getting started with translating.

I can successfully use 2.3-SNAPSHOT when I build it from a clone of the playframework repository (as described in the docs) and use addSbtPlugin("com.typesafe.play" % "play-docs-sbt-plugin" % "2.3-SNAPSHOT").

However, I can't get the docs for 2.4 working. When I do the same thing as I did for 2.3-SNAPSHOT, it fails.

I check out master in the playframework repository, cd into framework and ./build publish-local. Then I go to my new docs folder and use addSbtPlugin("com.typesafe.play" % "play-docs-sbt-plugin" % "2.4-SNAPSHOT"). It all works, I get to the point where it says "Documentation server started", but when I go to 127.0.0.1:9000, I get nothing and the sbt process spits out a stacktrace. The exception is "

com.typesafe.config.ConfigException$Missing: No configuration setting found for key 'play'""

Here's a screenshot:

The full stack trace can be found here: https://gist.github.com/thomastoye/00205a8049b240aeeae3

Can anyone try to reproduce? If not, please provide the commit hash of the playframework repo you're using so I can try with building that.

[Peter Vlugter]

Hi Thomas,

I've actually fixed this on a branch already. I'll put the fix into a separate pull request soon.

As a workaround for now, add the play version when starting up sbt:

sbt -Dplay.version=2.4-SNAPSHOT

This is why we don't see this problem with the ./build script. It really just needs any configuration under `play`.

Peter

On 22/10/2014, at 9:37 am, Thomas Toye <toye....@gmail.com> wrote:

> Hi everyone, I'm having some trouble getting started with translating.
>
> I can successfully use 2.3-SNAPSHOT when I build it from a clone of the playframework repository (as described in the docs) and use addSbtPlugin("com.typesafe.play" % "play-docs-sbt-plugin" % "2.3-SNAPSHOT").
>
> However, I can't get the docs for 2.4 working. When I do the same thing as I did for 2.3-SNAPSHOT, it fails.
>
> I check out master in the playframework repository, cd into framework and ./build publish-local. Then I go to my new docs folder and use addSbtPlugin("com.typesafe.play" % "play-docs-sbt-plugin" % "2.4-SNAPSHOT"). It all works, I get to the point where it says "Documentation server started", but when I go to 127.0.0.1:9000, I get nothing and the sbt process spits out a stacktrace. The exception is "
> com.typesafe.config.ConfigException$Missing: No configuration setting found for key 'play'""
>
> Here's a screenshot:
>
>

> The full stack trace can be found here: https://gist.github.com/thomastoye/00205a8049b240aeeae3
>
> Can anyone try to reproduce? If not, please provide the commit hash of the playframework repo you're using so I can try with building that.
>
>

[garbagetown]

Hi James,

We've began translating the documents for 2.3.5 on our 2.3.x branch.

So I'd like to make the 2.3.x branch as default version when I accessed to playframework.com/documentation.

Although I've changed the default branch of GitHub from 2.2.x to 2.3.x, when I accessed to playframework.com/documentation, the server still redirect me to playframework.com/documentation/ja/2.2.x/Home.

What am I supposed to do?

Regards,

Yuichiro Umezawa

2014年10月22日水曜日 5時45分13秒 UTC+9 Peter Vlugter:

> To unsubscribe from this group and stop receiving emails from it, send an email to play-framework-dev+unsub...@googlegroups.com.

[Thomas Toye]

Hi Peter,

Yes, this works. Thanks a lot :) Any idea when this pull request will be in master?
For anyone having trouble, here's the script I used to generate the scaffold: https://github.com/thomastoye/translation-project/blob/master/scaffold.sh

> To unsubscribe from this group and stop receiving emails from it, send an email to play-framework-dev+unsub...@googlegroups.com.

[Peter Vlugter]

On 23/10/2014, at 3:42 am, Thomas Toye <toye....@gmail.com> wrote:

> Any idea when this pull request will be in master?

It's in master:

https://github.com/playframework/playframework/pull/3536