Substitute en.toml for pedefined english shortcodes for i18n translation #12418

seokho-son · 2019-01-29T09:43:04Z

To fix #12160 (Issue in l10n docs referencing EN layouts outside l10n working directory)

This PR is a complement to the merged PR #12239.

Predefined English words in layouts/shortcodes has been substituted by i18n/en.toml
Modified i18n/ko.toml corresponding to en.toml translation.

seokho-son · 2019-01-29T09:48:43Z

/cc @jimangel @tengqm @chenopis

seokho-son · 2019-01-29T09:49:17Z

/cc @gochist

tengqm · 2019-01-29T09:53:35Z

i18n/en.toml

@@ -27,9 +27,30 @@ other = "Yes"
 [feedback_no]
 other = "No"

-[latest_version]
+[shortcode_latest_version]


don't see the value of adding 'shortcode_' to the entry

tengqm · 2019-01-29T09:55:49Z

layouts/shortcodes/deprecationwarning.html

-        For up-to-date documentation, see the <a href="{{ .Site.Params.currentUrl }}">latest</a> version.
+	 Kubernetes {{ .Param "version" }}
+	 {{ T "deprecation_warning" }}
+	 <a href="{{ .Site.Params.currentUrl }}">{{ T "latest_version" }}</a>


you changed the name of 'latest_version' in the i18n file!

@tengqm Thank you for the comment. I just noticed the mistake. I restored [latest_version] from [shortcode_latest_version].

tengqm · 2019-01-29T11:03:42Z

/lgtm

gochist · 2019-01-29T12:44:16Z

As a Korean speaker, it looks good to me.

kbhawkey · 2019-01-29T15:53:27Z

i18n/en.toml

+
+[shortcode_version_check_mustbeorlater_start]
+other = "Your Kubernetes server must be version "
+


Hello @seokho-son, a couple of thoughts:

Are the two keys above assigned to the same string?

I am not sure about prefixing the keys with shortcode or main. How do these prefixes help to identify or discriminate the keys? The keys could be differentiated if there is more than one value or variation on a given key. The names of the keys should be short and just indicate the actual text.

I am not a big fan of adding punctuation into the string values, unless the punctuation needs to be translated or if there is more than one version of a key such as latest version versus latest version..

@kbhawkey Thank you for your comments !

Are the two keys above assigned to the same string?
[replay] Yes. but it is intentional because of translation difficulty. Even though the strings are same, they can be translated differently according to position and structure of sentence.
For instance,
[shortcode_version_check_mustbe] can be translated into "쿠버네티스 서버는 다음 버전이어야 함. 버전" and
[shortcode_version_check_mustbeorlater_start] can be translated into "쿠버네티스 서버는 버전 "

I am not sure about prefixing the keys with shortcode or main. How do these prefixes help to identify or discriminate the keys? The keys could be differentiated if there is more than one value or variation on a given key. The names of the keys should be short and just indicate the actual text.
[replay] I understand your concerns. I think I used *.toml in unconventional way.
Usually, the prefixed English words in Layout files are not fully structured sentences, and we need to replace a key with whole string as is for a complete translation.
So, I think the key may not be used in other documents except the files in Layout.
The reason I placed the shortcode_<related file name> prefix is not for discrimination. It is for traceability to help contributors when they want to change any strings in Layout files.
If necessary, I think we can remove the prefix, and add an annotation in *.toml to separate sections for the keys used in shortcodes.
I am not sure about the main prefix. It is not a part of this PR, but I think it can be removed.

I am not a big fan of adding punctuation into the string values, unless the punctuation needs to be translated or if there is more than one version of a key such as latest version versus latest version..
[replay] I agree with you. I wish to reduce punctuation. However, for this moment, shortcodes includes several prefixed English words which is hard to be modified by i18n teams, and utilizing *.toml in translating remnant partials in templates and shortcodes was agreed in sig-docs meeting with consideration of management efficiency.

Please let me know if you have any further idea or requests regarding my reply. Thank you :)

@seokho-son 👋

[replay] Yes. but it is intentional because of translation difficulty. Even though the strings are same, they can be translated differently according to position and structure of sentence.

Thanks for this clarification. Please add a comment indicating that this string is duplicated specifically for Korean, so that other languages know that they don't need to duplicate it also.

If necessary, I think we can remove the prefix, and add an annotation in *.toml to separate sections for the keys used in shortcodes.

This is my preferred solution. Adding the shortcode_ prefix inconsistently seems to create more confusion than it solves.

@kbhawkey @zacharysarah To resolve your concerns, I updated PR as follows,

Removed one of the keys which have the same string. Instead, I rephrased the original sentence that causes Korean translation difficulty.

In en.toml [version_check_mustbe] other = "Your Kubernetes server must be version " [version_check_mustbeorlater] other = "Your Kubernetes server must be or later than version "

In version-check.html {{ if eq $minVersion (.Page.Param "version") }} {{ T "version_check_mustbe" }}{{ $minVersion }}. {{ else if $minVersion}} {{ T "version_check_mustbeorlater" }}{{ $minVersion }}.

Removed shortcode_ prefix as suggested.

Thank you :)

netlify · 2019-01-30T06:08:07Z

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 9a4e86d

https://deploy-preview-12418--kubernetes-io-master-staging.netlify.com

tengqm · 2019-01-30T12:52:27Z

/lgtm

kbhawkey · 2019-01-30T15:43:30Z

i18n/en.toml

-[shortcode_version_check_mustbeorlater_end]
-other = " or later."
+[version_check_mustbeorlater]
+other = "Your Kubernetes server must be or later than version "



Hello @seokho-son, looks good. One nit:
The value for version_check_mustbeorlater seems a bit unclear to me. Would this string work:
Your Kubernetes server must be at or later than version
Here is a page where version_check_mustbeorlater renders in English:
https://deploy-preview-12418--kubernetes-io-master-staging.netlify.com/docs/tasks/run-application/run-stateless-application-deployment/

@kbhawkey Thank you ! It looks good 👍 I updated PR.

Rev Substitute en.toml for pedefined english shortcodes Remove prefix Substitute en.toml for pedefined english shortcodes Rev minor Substitute en.toml for pedefined english shortcodes

seokho-son · 2019-02-07T08:56:37Z

PR was updated to resolve all the comments. @tengqm please take a look again. Thank you.

seokho-son · 2019-02-14T08:14:24Z

@zacharysarah Could you take a look on this pending PR regarding i18n.

zacharysarah · 2019-02-14T17:14:22Z

/approve

k8s-ci-robot · 2019-02-14T17:14:35Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: zacharysarah

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [zacharysarah]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

seokho-son · 2019-02-15T00:55:38Z

@zacharysarah Thank you. I hope let you know that it is not mergeable yet since previous lgtm label has been removed because of an update on this PR.

zacharysarah · 2019-02-15T01:30:33Z

/lgtm

Rev Substitute en.toml for pedefined english shortcodes Remove prefix Substitute en.toml for pedefined english shortcodes Rev minor Substitute en.toml for pedefined english shortcodes

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 29, 2019

k8s-ci-robot requested review from Rajakavitha1 and xiangpengzhao January 29, 2019 09:43

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jan 29, 2019

k8s-ci-robot requested review from chenopis, jimangel and tengqm January 29, 2019 09:48

k8s-ci-robot requested a review from gochist January 29, 2019 09:49

tengqm reviewed Jan 29, 2019

View reviewed changes

k8s-ci-robot assigned tengqm Jan 29, 2019

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 29, 2019

seokho-son mentioned this pull request Jan 29, 2019

REQUEST: New membership for seokho-son kubernetes/org#430

Closed

6 tasks

kbhawkey reviewed Jan 29, 2019

View reviewed changes

seokho-son force-pushed the i18n-layout-sub-toml branch from 079f9d7 to 4abf4b7 Compare January 30, 2019 06:06

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 30, 2019

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 30, 2019

kbhawkey reviewed Jan 30, 2019

View reviewed changes

seokho-son force-pushed the i18n-layout-sub-toml branch from 4abf4b7 to b3d8e68 Compare January 31, 2019 00:48

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 31, 2019

seokho-son force-pushed the i18n-layout-sub-toml branch from b3d8e68 to 9a4e86d Compare February 7, 2019 08:47

Substitute en.toml for pedefined english shortcodes

9a4e86d

Rev Substitute en.toml for pedefined english shortcodes Remove prefix Substitute en.toml for pedefined english shortcodes Rev minor Substitute en.toml for pedefined english shortcodes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 14, 2019

k8s-ci-robot assigned zacharysarah Feb 15, 2019

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 15, 2019

k8s-ci-robot merged commit bdd953f into kubernetes:master Feb 15, 2019

jimangel mentioned this pull request Mar 26, 2019

Update config.toml #13406

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Substitute en.toml for pedefined english shortcodes for i18n translation #12418

Substitute en.toml for pedefined english shortcodes for i18n translation #12418

seokho-son commented Jan 29, 2019

seokho-son commented Jan 29, 2019

seokho-son commented Jan 29, 2019

tengqm Jan 29, 2019

tengqm Jan 29, 2019

seokho-son Jan 29, 2019

tengqm Jan 29, 2019

tengqm commented Jan 29, 2019

gochist commented Jan 29, 2019 •

edited

Loading

kbhawkey Jan 29, 2019

seokho-son Jan 29, 2019

zacharysarah Jan 29, 2019

seokho-son Jan 30, 2019

netlify bot commented Jan 30, 2019 •

edited

Loading

tengqm commented Jan 30, 2019

kbhawkey Jan 30, 2019

seokho-son Jan 31, 2019

seokho-son commented Feb 7, 2019

seokho-son commented Feb 14, 2019

zacharysarah commented Feb 14, 2019

k8s-ci-robot commented Feb 14, 2019

seokho-son commented Feb 15, 2019 •

edited

Loading

zacharysarah commented Feb 15, 2019


		[shortcode_version_check_mustbeorlater_start]
		other = "Your Kubernetes server must be version "

Substitute en.toml for pedefined english shortcodes for i18n translation #12418

Substitute en.toml for pedefined english shortcodes for i18n translation #12418

Conversation

seokho-son commented Jan 29, 2019

seokho-son commented Jan 29, 2019

seokho-son commented Jan 29, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tengqm commented Jan 29, 2019

gochist commented Jan 29, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

netlify bot commented Jan 30, 2019 • edited Loading

tengqm commented Jan 30, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

seokho-son commented Feb 7, 2019

seokho-son commented Feb 14, 2019

zacharysarah commented Feb 14, 2019

k8s-ci-robot commented Feb 14, 2019

seokho-son commented Feb 15, 2019 • edited Loading

zacharysarah commented Feb 15, 2019

gochist commented Jan 29, 2019 •

edited

Loading

netlify bot commented Jan 30, 2019 •

edited

Loading

seokho-son commented Feb 15, 2019 •

edited

Loading