Skip to content
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

Merged
merged 1 commit into from
Jun 5, 2024

Conversation

my-git9
Copy link
Member

@my-git9 my-git9 commented May 25, 2024

content/zh/docs/concepts/context-propagation.md

@my-git9 my-git9 requested a review from a team May 25, 2024 08:41
content/zh/docs/concepts/context-propagation.md Outdated Show resolved Hide resolved
content/zh/docs/concepts/context-propagation.md Outdated Show resolved Hide resolved
content/zh/docs/concepts/context-propagation.md Outdated Show resolved Hide resolved
content/zh/docs/concepts/context-propagation.md Outdated Show resolved Hide resolved
Comment on lines 7 to 13
<!--
---
title: Context Propagation
weight: 10
description: Learn about the concept that enables Distributed Tracing.
---
-->
Copy link
Member

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.

Copy link
Member Author

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?

Copy link
Member

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.

Copy link
Contributor

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

Copy link
Member Author

@my-git9 my-git9 May 31, 2024

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:

  1. 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.
  2. 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)
  3. 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

Copy link
Member

@windsonsea windsonsea May 31, 2024

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?

Copy link
Contributor

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:

Let me respond more to your suggestion to embed en page segments as HTML comments in zh pages in the thread of #4302 (comment).

Copy link
Member

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?

Copy link
Contributor

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?

Copy link
Member

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

@my-git9 my-git9 force-pushed the context-propagation branch 2 times, most recently from a2b7c45 to 09fee49 Compare May 26, 2024 14:21
Copy link
Member

@windsonsea windsonsea left a 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.

Copy link
Contributor

@chalin chalin left a 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.

Comment on lines 7 to 13
<!--
---
title: Context Propagation
weight: 10
description: Learn about the concept that enables Distributed Tracing.
---
-->
Copy link
Contributor

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


通过上下文传播,[信号](/docs/concepts/signals)可以相互关联,
无论它们是在何处生成的。
尽管它不仅限于链路追踪,但它允许 [trace](/docs/concepts/signals/traces)
Copy link
Member

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/)

Copy link
Contributor

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?

Copy link
Member

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok TY, merging!

Copy link
Contributor

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 <xin.li@daocloud.io>
Copy link
Contributor

@chalin chalin left a 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 😄

@chalin
Copy link
Contributor

chalin commented Jun 5, 2024

@svrnm - other than @reyang's comment, which can be addressed now or later, this is ready to merge ✅

@chalin chalin merged commit 7bb7dbb into open-telemetry:main Jun 5, 2024
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants