-
Notifications
You must be signed in to change notification settings - Fork 72
i18n
Translators: Please complete this checklist before delivering a translated blog post
- To Japanese translators. This page is no longer used. Please use Translating release posts instead.
Reviewers: Please complete this checklist before approving a PR with a translated post
-
Review the blog for any untranslated words or phrases (machine translation can ignore links and formatted text)
-
Code blocks should remain in English (unless you know you have a specific code block that should be translated; if so, please indicate this to the reviewer with an explanation)
-
Links:
- Check link addresses to ensure they match the link addresses in the original blog post
- Check that text within links is properly translated (sometimes links are not fully translated due to machine translation)
-
Translators: If you would like to leave a link untranslated, please indicate this to the reviewer with an explanation
-
Example: Link in original English blog:
Translated link in Japanese blog:
-
-
Use translated images when available
- Currently available:
- "Ask a question on Stack Overflow" button (ja, zh-Hans) (e.g. blog_btn_stack_ja.svg for Japanese)
- To request a button translation, please follow the directions here
- Currently available:
-
Reviewers: If you have questions/feedback about the translation or want to translate parts of the post that were missed, please reach out to the original translator to discuss any questions, and have them review any newly added machine translations.
-
Once the post is merged into the draft branch and the build completes, please make sure to review your blog on the draft blogs site to confirm that formatting is also correct.
- If this is not your first time here, go to the next step. Otherwise run command
git clone [email protected]:OpenLiberty/blogs.git
on your machine. -
cd
on your local machine to theblogs
directory created bygit clone
-
git checkout prod
and rungit pull
-
git checkout -b <name-of-your-branch>
to create a new feature branch - Is there an existing directory for the language in under
<your_root_directory>/blogs/tree/prod/posts
?- If yes, continue to next step.
- If no, create a new directory named after the language's code in the
/posts
directory.
- Place the
adoc
file into the new/existing language directory. - Is the new post a translation of an existing post?
- If no, continue to next step.
- If yes, please include the attribute
blog-available-in-languages
in themd
file's front matter.- The front matter is the key-value pairs found between the two
---
lines. Here is an example of how to useblog-available-in-languages
attribute (https://raw.githubusercontent.com/OpenLiberty/blogs/prod/posts/ja/2022-10-29-22.0.0.10.adoc). - If there is a desire to give credit to the translator, please the translators name in the new post.
- Please make your
adoc
file similar to the existing post that is being translated. Date can be different. File format isYYYY-MM-DD-postname
. Here are two files that are the same content in different languages and different date.
- The front matter is the key-value pairs found between the two
- Open a pull request from your feature branch that is targeting
draft
branch and Set the reviewer to Kin Ueng (@kinueng)
This is one time setup from Kin's write-up.
- If this is not your first time here, go to the next step. Otherwise run command
git clone [email protected]:OpenLiberty/blogs.git
on your machine. -
cd
on your local machine to theblogs
directory created bygit clone
-
git checkout prod
and rungit pull
-
git checkout -b <name-of-your-branch>
to create a new feature branch - Is there an existing directory for the language in under
<your_root_directory>/blogs/tree/prod/posts
?- If yes, continue to next step.
- If no, create a new directory named after the language's code in the
/posts
directory.
- Find the new articles to get translated by periodically monitoring OpenLiberty blog or #openliberty-blog Slack channel.
- The translators may not have time to get the
.adoc
file. Send the file from the above repository. For example, if we want to get the Liberty 23.0.0.10 blog translated, send2023-10-17-23.0.0.10.adoc
to the translator.
The following instruction is what the translators are currently using:
-
Follow the local IBM's translation policy
-
Update the blog format
- Add the translator name and avatar
- Cross-reference to the same posts in other language.
Example of the blog format translation
layout: post title: "Open Liberty 23.0.0.10でJava 21をサポート" # Do NOT change the categories section categories: blog author_picture: https://avatars3.githubusercontent.com/lauracowen author_github: https://github.com/lauracowen seo-title: Open Liberty 23.0.0.10でJava 21をサポート - OpenLiberty.io seo-description: 2年前のJava 17以来の長期サポートリリースとなるJava 21をサポート。今すぐお試しください。 blog_description: 2年前のJava 17以来の長期サポートリリースとなるJava 21をサポート。今すぐお試しください。 open-graph-image: https://openliberty.io/img/twitter_card.jpg open-graph-image-alt: Open Liberty Logo
Example of additional entries
additional_authors: - name: 浅田 かおり (翻訳) github: https://github.com/kaori-asa image: https://avatars0.githubusercontent.com/kaori-asa blog-available-in-languages: - lang: en path: /blog/2023/10/17/2023-10-17-23.0.0.10.html
- Update the Stackoverflow link with your language. (Adding _ja in the svg file name.)
[link=https://stackoverflow.com/tags/open-liberty] image::img/blog/blog_btn_stack_ja.svg[Stack Overflowで質問する, align="center"]
-
(Add language specific instruction here)
-
Send the translated file back to us.
- Make sure to create a branch.
git checkout -b <name-of-your-branch>
to create a new feature branch - Place the translated file under
posts/[language]
directoryposts/2023-10-17-23.0.0.10.html posts/ja/2023-10-17-23.0.0.10.html
- The translator usually does not have time to get themselves familiarized with with the blog process. So we can update cross referenced blog articles. In the following example, the existing English blog article is updated with the new translated Japanese blog link.
blog-available-in-languages: - lang: ja path: /blog/ja/2023/10/17/2023-10-17-23.0.0.10.html
- Open a pull request from your feature branch.and Set the reviewer to one of the blog admins: David Mueller (@dmuelle), Kin Ueng (@kinueng), Steven Zvonek (@steven1046), Natalie Bernhard (@natalie-bernhard)
- Follow the instructions by the admins.