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

Fix zh copywriting by use AutoCorrect. #226

Merged
merged 4 commits into from
Jul 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .autocorrectignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
versioned_docs/
version-*/
4 changes: 4 additions & 0 deletions .autocorrectrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
rules:
space-bracket: 0
context:
codeblock: 0
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,16 @@ npm run build
npm run serve
```

## Check contents style

Before you commit your changes, you can check the style of the contents by running the following command:

```sh
$ npm run autocorrect --lint
```

And then follow the instructions to fix the style issues.

## Sync Documentation from `apache/eventmesh`

The `npm run fetch` script (`scripts/fetch.ts`) clones the `apache/eventmesh` repository and copies the documentations to `docs` and `i18n/zh/docusaurus-plugin-content-docs`. To update the documentation, please create a pull request in the `apache/eventmesh` repository.
Expand All @@ -38,4 +48,3 @@ npm run fetch

npm run start -- --locale en
```

Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

|**Data**|**Topic & Videos**|
|:----|:----|
|17/05/2022|[解决SaaS组合式应用集成标准化问题--EventMesh在华为的实践应用](https://www.bilibili.com/video/BV1cA4y1d7uw/?vd_source=7fa3cce048d504c8a511cfe78a2ec8c5)|
|17/05/2022|[解决 SaaS 组合式应用集成标准化问题--EventMesh 在华为的实践应用](https://www.bilibili.com/video/BV1cA4y1d7uw/?vd_source=7fa3cce048d504c8a511cfe78a2ec8c5)|
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@ Apache 为每个项目配置了一系列邮件列表。邮件列表是 Apache

社区日常运维中的很多事情都是通过邮件列表来承载的,比如技术讨论、任何想法或建议、项目问答、新功能/特性/重大变更的决定和通知、版本发布投票等。只要是和项目相关的,都可以在这里发起讨论。

只要订阅这个邮件列表,就可以第一时间了解EventMesh社区的最新动态,与社区保持同步。
只要订阅这个邮件列表,就可以第一时间了解 EventMesh 社区的最新动态,与社区保持同步。

**EventMesh项目邮件列表**
**EventMesh 项目邮件列表**

|名称|描述|订阅邮件|退订邮件|邮件归档|
|名称 | 描述 | 订阅邮件 | 退订邮件 | 邮件归档|
|:-----|:--------|:------|:-------|:-----|
| [users@eventmesh.apache.org](mailto:users@eventmesh.apache.org)|用户讨论| [订阅](mailto:users-subscribe@eventmesh.apache.org)| [退订](mailto:users-unsubscribe@eventmesh.apache.org)| [归档](https://lists.apache.org/list.html?users@eventmesh.apache.org)|
| [users@eventmesh.apache.org](mailto:users@eventmesh.apache.org)|用户讨论 | [订阅](mailto:users-subscribe@eventmesh.apache.org)| [退订](mailto:users-unsubscribe@eventmesh.apache.org)| [归档](https://lists.apache.org/list.html?users@eventmesh.apache.org)|
| [dev@eventmesh.apache.org](mailto:dev@eventmesh.apache.org) | 社区活动信息 | [订阅](mailto:dev-subscribe@eventmesh.apache.org) | [退订](mailto:dev-unsubscribe@eventmesh.apache.org) | [归档](https://lists.apache.org/list.html?dev@eventmesh.apache.org) |
| [commits@eventmesh.apache.org](mailto:commits@eventmesh.apache.org) | 代码库更新信息 | [订阅](mailto:commits-subscribe@eventmesh.apache.org) | [退订](mailto:commits-unsubscribe@eventmesh.apache.org) | [归档](https://lists.apache.org/list.html?commits@eventmesh.apache.org) |
| [issues@eventmesh.apache.org](mailto:issues@eventmesh.apache.org) | 问题或PR的评论和审查 | [订阅](mailto:issues-subscribe@eventmesh.apache.org) | [退订](mailto:issues-unsubscribe@eventmesh.apache.org) | [归档](https://lists.apache.org/list.html?issues@eventmesh.apache.org) |
| [issues@eventmesh.apache.org](mailto:issues@eventmesh.apache.org) | 问题或 PR 的评论和审查 | [订阅](mailto:issues-subscribe@eventmesh.apache.org) | [退订](mailto:issues-unsubscribe@eventmesh.apache.org) | [归档](https://lists.apache.org/list.html?issues@eventmesh.apache.org) |

## 1. 订阅邮件列表

Expand All @@ -27,7 +27,7 @@ Apache 为每个项目配置了一系列邮件列表。邮件列表是 Apache
步骤如下:

1. 发送一封没有任何内容和主题的邮件:`dev-subscribe@eventmesh.apache.org`
2. 等到收到一封主题为`确认订阅dev@eventmesh.apache.org`的邮件(如果长时间没有收到,请确认邮件是否被您的邮箱屏蔽,如果有未被屏蔽,长时间会收到回复,返回步骤1
2. 等到收到一封主题为`确认订阅dev@eventmesh.apache.org`的邮件(如果长时间没有收到,请确认邮件是否被您的邮箱屏蔽,如果有未被屏蔽,长时间会收到回复,返回步骤 1
3. 直接回复电子邮件,不更改主题行或添加电子邮件内容。
4. 等到您收到一封主题为“WELCOME to dev@eventmesh.apache.org”的电子邮件。
5. 如果您收到来自(4)的邮件,则您已成功订阅该邮件。要发起讨论,您可以直接发送电子邮件至 `dev@eventmesh.apache.org`,这将发送给订阅邮件列表的每个人。
Expand All @@ -43,11 +43,11 @@ Apache 为每个项目配置了一系列邮件列表。邮件列表是 Apache

## 3. 相关问题

> EventMesh的issues地址[https://github.com/apache/eventmesh/issues](https://github.com/apache/eventmesh/issues)
> EventMesh 的 issues 地址[https://github.com/apache/eventmesh/issues](https://github.com/apache/eventmesh/issues)

对于新的问题/想法,您可以通过\[new issues\]创建一个新的issue,并尽可能详细地描述issue,以便社区成员跟进、讨论和解决。对于项目的任何问题,建议先创建issue进行记录和跟进,这样整个过程可以很好的保存和归档,方便后续用户检索。
对于新的问题/想法,您可以通过\[new issues\]创建一个新的 issue,并尽可能详细地描述 issue,以便社区成员跟进、讨论和解决。对于项目的任何问题,建议先创建 issue 进行记录和跟进,这样整个过程可以很好的保存和归档,方便后续用户检索。

对于存在的问题,如果大家有兴趣,可以回复讨论,不限。对于任务/BUG类型的问题,有兴趣的可以关注或直接参与任务。非常欢迎社区伙伴为 EventMesh 贡献自己的力量。
对于存在的问题,如果大家有兴趣,可以回复讨论,不限。对于任务/BUG 类型的问题,有兴趣的可以关注或直接参与任务。非常欢迎社区伙伴为 EventMesh 贡献自己的力量。


## 4.邮件使用
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar_position: 1

> 当成为 Committer 后,你就会拥有一个 Apache 邮箱,本教程基于 `Gmail` 使用 Apache 邮箱。

#### 1. 登录Gmail
#### 1. 登录 Gmail

* [Gmail's official website](https://gmail.google.com) 在这里

Expand Down Expand Up @@ -37,12 +37,12 @@ Your ApacheID is: xxxx

#### 5. 添加 Apache 邮箱

* 登录到 [id.apache.org](https://id.apache.org/), 配置你的apache邮箱转发地址
* 登录到 [id.apache.org](https://id.apache.org/), 配置你的 apache 邮箱转发地址

![forwarding-email](/images/email/forwarding-email.png)

* 添加apache邮箱至Gmail配置
* 添加 apache 邮箱至 Gmail 配置

![add-apache-email](/images/email/add-apache-email.png)

> 未配置前,默认使用Gmail邮箱发送,可以添加apache邮箱作为默认发送邮箱。这个过程需要相关的配置和邮箱来确认和验证。
> 未配置前,默认使用 Gmail 邮箱发送,可以添加 apache 邮箱作为默认发送邮箱。这个过程需要相关的配置和邮箱来确认和验证。
Loading
Loading