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

Proposal: CloudEvents Spec in Chinese #899

Merged
merged 3 commits into from
Dec 6, 2021
Merged

Conversation

JieDing
Copy link
Member

@JieDing JieDing commented Nov 10, 2021

Proposed Changes

I'd like to translate a Chinese Version Specification based on the English one in order to lower the difficulty of reading and accelerate the spread of CloudEvents for Chinese developers.
-Currently, these documents below have been done based on the spec v1.0.1 and v1.0:
-README.md, primer.md and spec.md.
-other documents in both versions can be started later if necessary.
@duglin

@duglin
Copy link
Collaborator

duglin commented Nov 11, 2021

It's on the agenda for the call today.
Also, can you re-base, I think you have old commits in your list

@JieDing
Copy link
Member Author

JieDing commented Nov 11, 2021

It's on the agenda for the call today. Also, can you re-base, I think you have old commits in your list

Thanks a lot for replying. I'll re-base it asap.

@duglin
Copy link
Collaborator

duglin commented Nov 11, 2021

@JieDing the problem isn't the files, the problem is you have old (other people's) commits as part of this PR. You should rebase on top of the latest version of the branch (main) and only include your commits

in Chinese for people who are new to CloudEvents.
Most of the content is translated from the original English version.
It is strongly recommended to read the English version if you find anything lost in translation.

Choose a reason for hiding this comment

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

This section describes why we need CloudEvents in Chinese. Suggest adding a section title (both English and Chinese) to this section.

所有实现都必须支持 [JSON 格式](json-format.md)。

有关规范背后的历史、开发和设计原理等更多信息,
请参阅 CloudEvents [入门文档](primer_CN.md)。

Choose a reason for hiding this comment

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

These links are broken when I clicked them. Not sure if the issue is specific to me.

@JieDing JieDing changed the title Proposal: CloudEvents Spec in Chinese Proposal: CloudEvents Spec in Chinese Nov 12, 2021
| | 最新版本 | 工作草稿 |
| :---------------------------- | :-----------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------: |
| **核心标准:** |
| CloudEvents | [v1.0.1](https://github.com/cloudevents/spec/blob/v1.0.1/spec.md) | [master](https://github.com/cloudevents/spec/blob/master/spec.md) |
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think the links here are old since the branch is now "main"

@duglin
Copy link
Collaborator

duglin commented Nov 16, 2021

@JieDing thanks a ton for doing this. We discussed this on last week's call and there were just a few comments:

  • are you planning on keeping these documents up to date as we make changes?
  • can you put them under cloudevents/translated/zh-cn/ ? Is "zh-cn" the right code?

@JieDing
Copy link
Member Author

JieDing commented Nov 16, 2021

  • zh-cn

@JieDing thanks a ton for doing this. We discussed this on last week's call and there were just a few comments:

  • are you planning on keeping these documents up to date as we make changes?
  • can you put them under cloudevents/translated/zh-cn/ ? Is "zh-cn" the right code?
  • Yes, I'll keep translating documents as you make changes.
  • BTY, please @JieDing to let me know if there are some documents you prefer to translate first.
  • Documents would be translated based on my schedule if there is no specified order of translation.
  • I'll put documents under cloudevents/translated/zh-cn/ later. "zh-cn" is the right code.

@JieDing JieDing changed the base branch from v1.0.1 to main November 16, 2021 07:44
Signed-off-by: JieDing <dingjwilliams@gmail.com>
@JieDing
Copy link
Member Author

JieDing commented Nov 17, 2021

This PR seems doesn't meet the verify checker as it said "Can't find section '#XXX' in ./cloudevents/translated/zh-cn/primer_CN.md" where XXX are Chinese characters.
I was wondering if the href checker doesn't support Chinese since I can find and jump to those sections in my repository.
@duglin

事件(Events)在现代系统中无处不在。但不同的事件生产者往往用不同的规范来描述自己的事件。

对事件的统一描述的匮乏意味着开发者必须不断重新学习如何消费不同定义的事件。它同样限制了那些用来帮助事件数据完成
跨环境传输的库(如SDKs),工具(如事件路由器)和基础设施(如事件追踪系统)的发展。总体来看,这种匮乏严重阻碍了事件数据的可移植性和生产力。

Choose a reason for hiding this comment

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

no LF

Choose a reason for hiding this comment

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

use chinese bracket; use '、' replace ','.


CloudEvents是一个以通用格式来描述事件数据的标准。它提供了事件在服务、平台和系统中的互操作性。

CloudEvents 收获了从主流云厂商到SaaS公司的广泛关注。CloudEvents被[云原生计算基金会](https://cncf.io) (CNCF)持有,

Choose a reason for hiding this comment

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

no space, and I think below is better.
从主流云厂商到SaaS公司,工业界对CloudEvents兴趣浓烈。CloudEvents项目由云原生计算基金会托管,于2018年5月15日成为云原生沙箱级项目。


现有文件如下:

| | 最新版本 | 工作草稿 |

Choose a reason for hiding this comment

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

工作草案

| Primer | [v1.0.1](https://github.com/cloudevents/spec/blob/v1.0.1/primer.md) | [WIP](https://github.com/cloudevents/spec/blob/main/cloudevents/primer.md) |
| Proprietary Specifications | - | [WIP](https://github.com/cloudevents/spec/blob/main/cloudevents/proprietary-specs.md) |

对于初次接触CloudEvents的同学,可以通过阅读[入门文档](primer_CN.md)增加对CloudEvents规范的目标和设计理念

Choose a reason for hiding this comment

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

推荐先行阅读入门文档了解CloudEvents规范的目标和设计理念,再阅读核心规范

| Proprietary Specifications | - | [WIP](https://github.com/cloudevents/spec/blob/main/cloudevents/proprietary-specs.md) |

对于初次接触CloudEvents的同学,可以通过阅读[入门文档](primer_CN.md)增加对CloudEvents规范的目标和设计理念
的总体理解,

Choose a reason for hiding this comment

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

no newline

的总体理解,
希望在最短时间内使用CloudEvents 规范的同学,可以直接阅读[核心规范](spec_CN.md)。

由于并非所有事件生产者都默认生产符合CloudEvents规范的事件,因此可以用[CloudEvents适配器](https://github.com/cloudevents/spec/blob/main/cloudevents/adapters.md)

Choose a reason for hiding this comment

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

现实环境中,很多事件生产者没有生成符合CloudEvents规范的事件,因此我们给出了将主流事件格式转换为CloudEvents格式的适配方法,详情请参考CloudEvents适配器

Copy link
Collaborator

Choose a reason for hiding this comment

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

I kind of like the original version better.

@duglin
Copy link
Collaborator

duglin commented Nov 20, 2021

@JieDing did you want to address the comments made?

Signed-off-by: JieDing <dingjwilliams@gmail.com>
@JieDing
Copy link
Member Author

JieDing commented Nov 22, 2021

@JieDing did you want to address the comments made?
I've made some changes to see if it's gonna address the problem
@duglin

fix typo

add translation

Signed-off-by: JieDing <dingjwilliams@gmail.com>
@duglin
Copy link
Collaborator

duglin commented Nov 29, 2021

@JieDing thanks! I'll add it to this week's agenda for final approaval

@JieDing
Copy link
Member Author

JieDing commented Nov 29, 2021

@JieDing thanks! I'll add it to this week's agenda for final approaval

I do feel happy to make a contribution to CloudEvents. Just let me know if anything needs to be modified.

@duglin
Copy link
Collaborator

duglin commented Dec 6, 2021

Approved on the 12/02 call
thanks again @JieDing !!

@duglin duglin merged commit bd9cd1e into cloudevents:main Dec 6, 2021
@JieDing JieDing deleted the v1.0.1_CN branch December 9, 2021 07:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants