-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[zh] Localize context-propagation.md #4536
Conversation
c73ed46
to
dd8e89c
Compare
<!-- | ||
--- | ||
title: Context Propagation | ||
weight: 10 | ||
description: Learn about the concept that enables Distributed Tracing. | ||
--- | ||
--> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not very necessary to copy the en text and comment it out. Only zh text is acceptable.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would be easier to review if the original text is annotated here. Otherwise, the reviewer needs to open the original text to compare, which makes the review work more cumbersome. What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fine, thanks, it can provide some more conveniences.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I second @windsonsea comment, this should be removed in the spirit of keeping things DRY. Otherwise, how do you know that the comment is up-to-date? You'll need to open the original file to double check anyways.
Please remove all embedded HTML comments.
What would be more useful would be to include, in the front matter, a permalink to the specific version (including the commit hash) of the en
page that was used to create this translation, but we can discuss this separately. /cc @open-telemetry/docs-approvers
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your attention, but I still stick to my point of view for the following reasons:
- During the first synchronization, we can easily compare with the original text one-to-one, but during the second or subsequent synchronization, it is difficult for both the submitter and the reviewer to find the differences between the translation and the original text without comments. Adding comments is not for the comparison of the first translation, but for the convenience of comparison during subsequent synchronization. It allows us to more easily locate the differences between the translation and the original text. Otherwise, even if we know that the two articles are different, it is difficult to find the differences if the articles are very long.
- If we continue to keep the translation consistent with the original text, we should make the subsequent work simpler so that more people can participate in it (I think adding comments can make the subsequent synchronization work simpler)
- I personally think that the localization of k8s documents is a better example: https://github.com/kubernetes/website/blob/main/content/zh-cn/docs/contribute/localization.md?plain=1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO, it appears to be an advanced option in future, but shall not be mandatory currently.
K8s only applies this policy to the zh-cn localization and not to other languages.
Could we simply follow standard localization practices at the start?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for providing more context, and the reference to the K8s example.
FYI, I've started two threads of discussion in the hopes of figuring out what "best practices" there might already be in use at the CNCF or elsewhere:
- Internationalization (i18n) and localization (l10n) #4302 (comment)
- https://cloud-native.slack.com/archives/CUJ6W5TLM/p1717149935431579
Let me respond more to your suggestion to embed en
page segments as HTML comments in zh
pages in the thread of #4302 (comment).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is this blocking for merging this PR?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I'd like to propose that you give me a couple of days to explore alternatives and make a concrete proposal for use in this repo. I've created
to track this issue. Here's an excerpt:
Our support for translations is nascent. We have an opportunity to get it right, or at least good enough, from the start.
Let me put something together to show you what I have in mind. In the meantime, I'd suggest delaying the merge of other zh page translations.
@svrnm, WDYT?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @chalin
@my-git9 we discussed this during yesterdays SIG comms meeting and for now we do not want to have the english version inlined. As @chalin stated our support for translation is young and experimental and we do not want to make such a decision right now, as removing the blocks of english translations after the fact is harder than adding them if we decide to apply this technique.
See #4582 for more details
a2b7c45
to
09fee49
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The preview looks good.
09fee49
to
cec14da
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @my-git9: thanks for the translation. See the inline comment, and also please rebase from main
.
<!-- | ||
--- | ||
title: Context Propagation | ||
weight: 10 | ||
description: Learn about the concept that enables Distributed Tracing. | ||
--- | ||
--> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I second @windsonsea comment, this should be removed in the spirit of keeping things DRY. Otherwise, how do you know that the comment is up-to-date? You'll need to open the original file to double check anyways.
Please remove all embedded HTML comments.
What would be more useful would be to include, in the front matter, a permalink to the specific version (including the commit hash) of the en
page that was used to create this translation, but we can discuss this separately. /cc @open-telemetry/docs-approvers
c1efe15
to
ed39e82
Compare
ed39e82
to
84fafbc
Compare
|
||
通过上下文传播,[信号](/docs/concepts/signals)可以相互关联, | ||
无论它们是在何处生成的。 | ||
尽管它不仅限于链路追踪,但它允许 [trace](/docs/concepts/signals/traces) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems we have different translations for the same word, would be good to keep consistency.
旨在创建和管理遥测数据,如[链路](/zh/docs/concepts/signals/traces/)、 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this change blocking @reyang?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not blocking, we can cover it in separate PRs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok TY, merging!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Signed-off-by: xin.li <[email protected]>
84fafbc
to
9d4afbb
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM if @reyang is happy 😄
content/zh/docs/concepts/context-propagation.md