Localization project of https://quarkus.io

193 views
Skip to first unread message

Yoshikazu Nojima

unread,
Feb 25, 2021, 8:02:13 AM2/25/21
to quark...@googlegroups.com
Hello Everyone,

I'm Yoshikazu from Red Hat Japan.
I and some Red Hat Japan members started Japanese localization of https://quarkus.io as our side project.

Localized site(WIP): https://ja-quarkusio.surge.sh/

It is important for Japanese community to have localized documents for adoption,
and we started localizing https://quarkus.io
We'd like to donate the localized site to Quarkus community and make it official if it is okay.
If we could host the site on the subdomain of quarkus.io, it would be best. (i.e. https://ja.quarkus.io )
We are using this repository for localization: https://github.com/doc-l10n-kit/ja-quarkusio

If the donation is acceptable, I'd like to discuss the details.

Regards,

--

Yoshikazu Nojima

Red Hat

4-1-18 Ebisu, Shibuya-ku, Tokyo, JAPAN

Ebisu Neonato 3F

yno...@redhat.com   

Yoshikazu Nojima

unread,
Feb 25, 2021, 8:50:11 PM2/25/21
to Quarkus Development mailing list
Let me share some details about how the localization architecture is implemented because some may concern localization project continuity.

In this localization project, we use po4a (https://po4a.org/) and some utilities on GitHub Actions to make localization systematic.
We extracts texts from original asciidoctor contents to .po files with po4a utility,
pre-translates with a translation memory and DeepL translation API to make a draft, post-edit manually to improve fluency,
write-back the translation to original asciidoctor files, and build the localized site with Jekyll on GitHub Actions.

When you post a new article to https://quarkus.io, it will be automatically synced to the localized site within 1 hour by GitHub Actions, 
but without localization (Machine translation is regarded as a draft, and will not be published).
When a localization project member finds a new article and submit a pull request to https://github.com/doc-l10n-kit/ja-quarkusio repo to translate the article,
the article will be localized. (ex. translation of 2021-02-11-quarkus-1-11-3-final-released.adoc.po : https://github.com/doc-l10n-kit/ja-quarkusio/pull/72/files)

So, we can localize the site with minimum effort, and visitors can read the up-to-date contents at least in English in the localized site.

For more details, please check the "Localization architecture" section of https://github.com/doc-l10n-kit/ja-quarkusio .

Regards,
Yoshikazu


2021年2月25日木曜日 22:02:13 UTC+9 Yoshikazu Nojima:

James Cobb

unread,
Mar 2, 2021, 8:34:26 AM3/2/21
to yno...@redhat.com, Quarkus Development mailing list
Hello Yoshikazu,

This is an amazing thing! I’m so glad to see there are community efforts to translate the site into different languages and the extent you and others have gone to automate is great. Creating a easy process to keep it up to date is important so they can be kept in sync.

I’d be interested in knowing your pain points in translating the Jekyll site  based your experiences so we can make future translations easier. It would be great to know what we can do on the main site’s build structure to allow for easier/automated translations.

I’d also suggest using a URL like “jp.quarkus.io” so it’s presented as part of the overall site for perceived legitimacy as well as creating the precedence for other community efforts in translations.

Thank you,
James



--
You received this message because you are subscribed to the Google Groups "Quarkus Development mailing list" group.
To unsubscribe from this group and stop receiving emails from it, send an email to quarkus-dev...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/quarkus-dev/08fc5c66-7845-474d-9095-beb0cc769c68n%40googlegroups.com.

Yoshikazu Nojima

unread,
Mar 2, 2021, 10:01:32 PM3/2/21
to James Cobb, Quarkus Development mailing list
Hello James,
Thank you for kind words.

There are few pain points in localizing the site built with Jekyll, but localization of texts written as literals in HTML templates is a bit annoying.
Texts written in Asciidoctor or Markdown can be extracted and translated by po4a utility, but po4a cannot be used for HTML templates.
It would be helpful if you could write the text in an external YAML file, which can be processed by po4a instead of writing the text as a literal in the HTML template.

> "ja.quarkus.io"

Yes, I'd like to use the sub domain. Do you know who is the admin of "quarkus.io" domain? I'd like to ask permission and discuss how to realize it.
- Name server configuration
- Hosting service (surge.sh? GitHub Pages? anything else?)
- GitHub repo (https://github.com/doc-l10n-kit/ja-quarkusio) transfer to https://github.com/quarkusio/ org. if necessary

Regards,
Yoshikazu

2021年3月2日(火) 22:34 James Cobb <jc...@redhat.com>:

Max Rydahl Andersen

unread,
Mar 5, 2021, 9:32:57 AM3/5/21
to Quarkus Development mailing list

hi, Yoshikazu - i can request quarkus.io domain changes if/when we need it.

im not sure using domain name prefix is the best approach - but probably the simpest.

Yoshikazu Nojima

unread,
Mar 8, 2021, 4:35:49 AM3/8/21
to Max Rydahl Andersen, Quarkus Development mailing list
Hi Max,

I think the simplest approach is the best approach.

Could you request to add a new CNAME record "ja.quarkus.io", which points "na-west1.surge.sh."?
 "na-west1.surge.sh." is the endpoint of  surge.sh.

I reserved the "ja.quarkus.io" project of surge.sh, and it's ready to add a CNAME record "ja.quarkus.io".

Regards,
Yoshikazu


2021年3月5日(金) 23:33 Max Rydahl Andersen <mand...@redhat.com>:

hi, Yoshikazu - i can request quarkus.io domain changes if/when we need it.

im not sure using domain name prefix is the best approach - but probably the simpest.
On Wednesday, March 3, 2021 at 4:01:32 AM UTC+1 Yoshikazu Nojima wrote:
Hello James,
Thank you for kind words.

There are few pain points in localizing the site built with Jekyll, but localization of texts written as literals in HTML templates is a bit annoying.
Texts written in Asciidoctor or Markdown can be extracted and translated by po4a utility, but po4a cannot be used for HTML templates.
It would be helpful if you could write the text in an external YAML file, which can be processed by po4a instead of writing the text as a literal in the HTML template.

> "ja.quarkus.io"

Yes, I'd like to use the sub domain. Do you know who is the admin of "quarkus.io" domain? I'd like to ask permission and discuss how to realize it.
- Name server configuration
- Hosting service (surge.sh GitHub Pages? anything else?)

--
You received this message because you are subscribed to a topic in the Google Groups "Quarkus Development mailing list" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/quarkus-dev/AuOcmNUJGCQ/unsubscribe.
To unsubscribe from this group and all its topics, send an email to quarkus-dev...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/quarkus-dev/40fded08-bacb-448e-af2f-c5e36db78583n%40googlegroups.com.

James Cobb

unread,
Mar 8, 2021, 9:27:02 AM3/8/21
to Yoshikazu Nojima, Quarkus Development mailing list
Thanks for the feedback. 

We’ll look into making changes to the Jekyll structure as we move forward to future proof localization.

James

Max Rydahl Andersen

unread,
Mar 9, 2021, 10:56:33 AM3/9/21
to Yoshikazu Nojima, Quarkus Development mailing list

> Hi Max,
>
> I think the simplest approach is the best approach.

agreed.

>
> Could you request to add a new CNAME record "ja.quarkus.io", which
> points "
> na-west1.surge.sh."?
> "na-west1.surge.sh." is the endpoint of surge.sh.
> https://surge.sh/help/adding-a-custom-domain
>
> I reserved the "ja.quarkus.io" project of surge.sh, and it's ready to
> add a
> CNAME record "ja.quarkus.io".

I had a chat on how we can enable this localisation the best and we
really like the setup you have
and the way it automated and serve english content if japanese is
outdated.

What we would like though is that the repository moves into quarkusio
and we set it up to use GitHub pages as then a) anyone in quarkusio can
help out and fix issues if need be b)
we already serve out from GitHub pages quarkus.io which is CDN backed.

can we make that happen or is there a specific reasons to serve out from
surge ?
>>>>> Red Hat <https://www.redhat.com/>
>>>>> 4-1-18 Ebisu, Shibuya-ku, Tokyo, JAPAN
>>>>> Ebisu Neonato 3F
>>>>> yno...@redhat.com
>>>>> <https://www.redhat.com/>
>>>>>
>>>>
>>>> --
>>>> You received this message because you are subscribed to the Google
>>>> Groups "Quarkus Development mailing list" group.
>>>> To unsubscribe from this group and stop receiving emails from it,
>>>> send
>>>> an email to quarkus-dev...@googlegroups.com.
>>>> To view this discussion on the web visit
>>>> https://groups.google.com/d/msgid/quarkus-dev/08fc5c66-7845-474d-9095-beb0cc769c68n%40googlegroups.com
>>>> <https://groups.google.com/d/msgid/quarkus-dev/08fc5c66-7845-474d-9095-beb0cc769c68n%40googlegroups.com?utm_medium=email&utm_source=footer>
>>>> .
>>>>
>>>>
>>>> --
>> You received this message because you are subscribed to a topic in
>> the
>> Google Groups "Quarkus Development mailing list" group.
>> To unsubscribe from this topic, visit
>> https://groups.google.com/d/topic/quarkus-dev/AuOcmNUJGCQ/unsubscribe.
>> To unsubscribe from this group and all its topics, send an email to
>> quarkus-dev...@googlegroups.com.
>> To view this discussion on the web visit
>> https://groups.google.com/d/msgid/quarkus-dev/40fded08-bacb-448e-af2f-c5e36db78583n%40googlegroups.com
>> <https://groups.google.com/d/msgid/quarkus-dev/40fded08-bacb-448e-af2f-c5e36db78583n%40googlegroups.com?utm_medium=email&utm_source=footer>
>> .
>>


/max
https://xam.dk/about

Yoshikazu Nojima

unread,
Mar 9, 2021, 9:07:02 PM3/9/21
to Max Rydahl Andersen, Quarkus Development mailing list
Hi Max,

> Repository transfer to "quarkusio" GitHub org.

Yes, let's do it.
Is it possible to add me to "quarkusio" GitHub org? because repository transfer needs repository creation permission to the target GitHub org.
https://docs.github.com/en/github/administering-a-repository/transferring-a-repository

Then, I'll transfer the localization repository to "quarkusio" GitHub org.

> Serving from GitHub pages

Yes, we can use GitHub pages to serve "ja.quarkus.io".
In that case, could you request to add "ja.quarkus.io" CNAME record that points to "quarkusio.github.io"?

Regards,
Yoshikazu

2021年3月10日(水) 0:56 Max Rydahl Andersen <mand...@redhat.com>:

Max Andersen

unread,
Mar 9, 2021, 11:29:14 PM3/9/21
to Yoshikazu Nojima, Quarkus Development mailing list
Let's do it the other way. You add me to jp.quarkus.io and I can move it. 

Just let know and I'll do it asap. 

/max

Yoshikazu Nojima

unread,
Mar 9, 2021, 11:36:02 PM3/9/21
to Max Andersen, Quarkus Development mailing list
Good solution.

2021年3月10日(水) 13:29 Max Andersen <mand...@redhat.com>:

Max Andersen

unread,
Mar 9, 2021, 11:45:09 PM3/9/21
to Yoshikazu Nojima, Quarkus Development mailing list
Seems I can't do move operations from phone based browser. I'll move it as soon as I'm back at my desk. 

/max

Yoshikazu Nojima

unread,
Mar 9, 2021, 11:53:02 PM3/9/21
to Max Andersen, Quarkus Development mailing list
It seems you haven't accepted the invitation email to the l10n repository yet.
After you accept the invitation, you can transfer the repository.

Regards,
Yoshikazu

2021年3月10日(水) 13:45 Max Andersen <mand...@redhat.com>:

Max Andersen

unread,
Mar 10, 2021, 1:53:00 AM3/10/21
to Yoshikazu Nojima, Quarkus Development mailing list
Fyi to All - quarkusio/ja.quarkus.io repository is now a thing. 

Awaiting ja.qurkus.io DNS records to be updated by red hat IT. Normally happen within a few days. Sometimes sooner. I'll post when I get confirmation. 

Ynojima, nobusue and chiroito are setup on Ja.quarkus.io team to push and maintain the repo. 

Prs open For business :)

Thanks to you All, This Will ne exciting :)


/max

Max Rydahl Andersen

unread,
Mar 11, 2021, 6:07:36 PM3/11/21
to Quarkus Development mailing list

hey,

ja.quarkus.io DNS got activated yesterday and we verified it all worked
like the english announcement at https://quarkus.io/blog/ja-quarkus-io/
triggered https://github.com/quarkusio/ja.quarkus.io/pull/204

and reported fixed https://github.com/quarkusio/ja.quarkus.io/issues/205


great system :)

/max
https://xam.dk/about

Forwarded message:

Reply all
Reply to author
Forward
0 new messages