Skip to content

Commit

Permalink
Fix zh copywriting by use AutoCorrect.
Browse files Browse the repository at this point in the history
  • Loading branch information
huacnlee committed Jul 10, 2024
1 parent cb3bf33 commit 82acf2e
Show file tree
Hide file tree
Showing 22 changed files with 9,425 additions and 186 deletions.
2 changes: 2 additions & 0 deletions .autocorrectignore
Original file line number Diff line number Diff line change
@@ -0,0 +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
$ yarn 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
```

22 changes: 11 additions & 11 deletions community/02-how-to-subscribe.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,20 @@ As long as you subscribe to this mailing list, you can get the latest developmen
## 1. Subscribe to the mailing list
**For example,Take subscribing to the [email protected] mailing list**

The steps are as follows
1. Send an email without any content or subject: `[email protected]`
2. Wait until you receive an email with the subject line `confirm subscribe to [email protected]` (if you have not received it for a long time, please confirm whether the email is blocked by your email, if you have not been blocked and will receive a reply for a long time, return to step 1)
The steps are as follows:
1. Send an email without any content or subject: `[email protected]`.
2. Wait until you receive an email with the subject line `confirm subscribe to [email protected]` (if you have not received it for a long time, please confirm whether the email is blocked by your email, if you have not been blocked and will receive a reply for a long time, return to step 1).
3. Reply directly to the email without changing the subject line or adding the email content.
4. Wait until you receive an email with the subject line `WELCOME to [email protected]` .
4. Wait until you receive an email with the subject line `WELCOME to [email protected]`.
5. If you receive an email from (4), you have successfully subscribed to the email. To initiate a discussion, you can send an email directly to `[email protected]`, which will be sent to everyone who subscribed to the mailing list.

## 2. Unsubscribe from the mailing list
The steps for unsubscribing to a mailing list are similar to those for subscribing to a mailing list:
1. Send an email without any content or subject to: `[email protected]`
2. Wait until you receive an email with the subject line `confirm unsubscribe from [email protected]`
3. Reply directly to the email without changing the subject line or adding the email content
4. Wait until you receive an email with the subject line `GOODBYE from [email protected]`
5. Unsubscribe success
The steps for unsubscribing to a mailing list are similar to those for subscribing to a mailing list:
1. Send an email without any content or subject to: `[email protected]`.
2. Wait until you receive an email with the subject line `confirm unsubscribe from [email protected]`.
3. Reply directly to the email without changing the subject line or adding the email content.
4. Wait until you receive an email with the subject line `GOODBYE from [email protected]`.
5. Unsubscribe success.


## 3. Issues related
Expand All @@ -51,4 +51,4 @@ For existing issues, if you are interested, you can reply and discuss as much as

## 4. Mail usage

Please refer to [How to use the mailing list](03-how-to-use-email.md) for email specifications and tips
Please refer to [How to use the mailing list](03-how-to-use-email.md) for email specifications and tips.
8 changes: 4 additions & 4 deletions community/04-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ $ gpg --version #Check the version, it should be 2.x

According to the prompt, generate the key

> Noteplease use Apache mail box generate GPG Key
> Note: please use Apache mail box generate GPG Key
```shell
$ gpg --full-gen-key
Expand Down Expand Up @@ -94,7 +94,7 @@ $ gpg --keyserver hkp://keyserver.ubuntu.com --recv-keys 579C25F5 # Verify wheth
default-key 28681CB1
```
**If there are multiple public keys, useless keys can also be deleted**
**If there are multiple public keys, useless keys can also be deleted:**
```shell
$ gpg --delete-secret-keys 29BBC3CB # first delete the private key and specify the key id
Expand Down Expand Up @@ -250,7 +250,7 @@ Execute the following command, you need to sign and encrypt files such as jar, s
$ gradle signMavenJavaPublication publish
```
After the above command is executed successfully, the version to be released will be automatically uploaded to Apache's staging repository. All Artifacts that are deployed to the remote [maven repository](http://repository.apache.org/) will be in the staging statevisit https://repository.apache.org/#stagingRepositories ,log in with Apache's LDAP account, You will see the uploaded version, and the content of the `Repository` column is ${STAGING.REPOSITORY}. Click `Close` to tell Nexus that the build is complete and only then will the build be usable. If there is a problem with the electronic signature, `Close` will fail, and you can view the failure information through `Activity`.
After the above command is executed successfully, the version to be released will be automatically uploaded to Apache's staging repository. All Artifacts that are deployed to the remote [maven repository](http://repository.apache.org/) will be in the staging state, visit https://repository.apache.org/#stagingRepositories ,log in with Apache's LDAP account, You will see the uploaded version, and the content of the `Repository` column is ${STAGING.REPOSITORY}. Click `Close` to tell Nexus that the build is complete and only then will the build be usable. If there is a problem with the electronic signature, `Close` will fail, and you can view the failure information through `Activity`.
Expand Down Expand Up @@ -604,7 +604,7 @@ https://eventmesh.apache.org/download/
https://eventmesh.apache.org/zh/download/
Download links for GPG signature files and hash verification files should use this prefix`https://downloads.apache.org/eventmesh/`
Download links for GPG signature files and hash verification files should use this prefix: `https://downloads.apache.org/eventmesh/`
> Note: The project download link should use https://www.apache.org/dyn/closer.lua instead of closer.cgi or mirrors.cgi
Expand Down
2 changes: 1 addition & 1 deletion community/05-how-to-vote-a-committer-pmc.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ After receiving the notification email that the account was created successfully

- Enter [Apache Account Utility Platform] (https://id.apache.org/), create a password, set up a personal email address (`forwarding email address`) and a GitHub account (`Your GitHub Username`).
- If you want to use `[email protected]` mail service, please refer to [here](https://infra.apache.org/committer-email.html). Gmail is recommended as this forwarding mode is not easily found in most email service setups.
- FollowAuthorize GitHub 2FA wiki(https://help.github.com/articles/configuring-two-factor-authentication-via-a-totp-mobile-app/) to enable two-factor authorization (2FA) in [Github ](http://github.com/). When you set 2FA to "off", it will be delisted from the corresponding Apache committer write permission group until you set it again. (**Note: pay attention to recovery codes like passwords!**)
- Follow [Authorize GitHub 2FA wiki](https://help.github.com/articles/configuring-two-factor-authentication-via-a-totp-mobile-app/) to enable two-factor authorization (2FA) in [Github ](http://github.com/). When you set 2FA to "off", it will be delisted from the corresponding Apache committer write permission group until you set it again. (**Note: pay attention to recovery codes like passwords!**)
- Use the [GitBox Account Linking Utility] (https://gitbox.apache.org/setup/) to obtain the write permission of the EventMesh project.
- [eventmesh-website](https://eventmesh.apache.org/team) related page update

Expand Down
2 changes: 1 addition & 1 deletion docs/design-document/03-connect/02-http-connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ The data format of the message sent by the HTTP sink connector is as follows:
- time: the time the request was sent
- uuid: request unique identifier, one-to-one with the uuid of the callback data structure in webhook mode
- eventId: event ID, composed of type and offset
- dataactual data to be sent
- data: actual data to be sent

```json
{
Expand Down
8 changes: 4 additions & 4 deletions docs/design-document/03-connect/10-file-connector.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# File

## FileSinkConnectorWrites File file from EventMesh
## FileSinkConnector: Writes File file from EventMesh

1. Start your EventMesh Runtime.
2. Enable sinkConnector and check `sink-config.yml`.
3. Started FileConnectServerIt will subscribe to the topic defined in `pubSubConfig.subject` in the EventMesh RuntimeAnd write the data to the path located : `connectorConfig.topic`/Year/Month/Day ; the file named:【 `connectorConfig.topic` + Current time Hour (24 hours) + timestamp 】.
3. Started FileConnectServer, It will subscribe to the topic defined in `pubSubConfig.subject` in the EventMesh Runtime, And write the data to the path located : `connectorConfig.topic`/Year/Month/Day ; the file named:【 `connectorConfig.topic` + Current time Hour (24 hours) + timestamp 】.
4. Using the Topic specified in `pubSubConfig.subject`, send a message to EventMesh, which you will persist in the file.

```yaml
Expand All @@ -24,11 +24,11 @@ connectorConfig:
topic: TopicTest
```
## FileSourceConnectorRead from File to EventMesh
## FileSourceConnector: Read from File to EventMesh
1. Start your EventMesh Runtime.
2. Enable sinkConnector and check `source-config.yml`.
3. Started FileConnectServerIt sends the data read from `connectorConfig.filePath` to `pubSubConfig.subject` in the EventMesh Runtime.
3. Started FileConnectServer, It sends the data read from `connectorConfig.filePath` to `pubSubConfig.subject` in the EventMesh Runtime.
4. The append to the file content is recognized, and you receive the message in EventMesh.

```yaml
Expand Down
4 changes: 2 additions & 2 deletions docs/design-document/03-connect/11-kafka-connector.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Kafka

## KafkaSinkConnectorFrom EventMesh to Kafka
## KafkaSinkConnector: From EventMesh to Kafka

1. Start your EventMesh Runtime.
2. Enable sinkConnector and check `sink-config.yml`.
Expand All @@ -27,7 +27,7 @@ connectorConfig:
valueConverter: org.apache.kafka.common.serialization.StringSerializer
```
## KafkaSourceConnectorFrom Kafka to EventMesh
## KafkaSourceConnector: From Kafka to EventMesh
1. Start your EventMesh Runtime.
2. Enable sourceConnector and check `source-config.yml`.
Expand Down
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 项目邮件列表**

|名称|描述|订阅邮件|退订邮件|邮件归档|
|名称 | 描述 | 订阅邮件 | 退订邮件 | 邮件归档|
|:-----|:--------|:------|:-------|:-----|
| [[email protected]](mailto:[email protected])|用户讨论| [订阅](mailto:[email protected])| [退订](mailto:[email protected])| [归档](https://lists.apache.org/[email protected])|
| [[email protected]](mailto:[email protected])|用户讨论 | [订阅](mailto:[email protected])| [退订](mailto:[email protected])| [归档](https://lists.apache.org/[email protected])|
| [[email protected]](mailto:[email protected]) | 社区活动信息 | [订阅](mailto:[email protected]) | [退订](mailto:[email protected]) | [归档](https://lists.apache.org/[email protected]) |
| [[email protected]](mailto:[email protected]) | 代码库更新信息 | [订阅](mailto:[email protected]) | [退订](mailto:[email protected]) | [归档](https://lists.apache.org/[email protected]) |
| [[email protected]](mailto:[email protected]) | 问题或PR的评论和审查 | [订阅](mailto:[email protected]) | [退订](mailto:[email protected]) | [归档](https://lists.apache.org/[email protected]) |
| [[email protected]](mailto:[email protected]) | 问题或 PR 的评论和审查 | [订阅](mailto:[email protected]) | [退订](mailto:[email protected]) | [归档](https://lists.apache.org/[email protected]) |

## 1. 订阅邮件列表

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

1. 发送一封没有任何内容和主题的邮件:`[email protected]`
2. 等到收到一封主题为`确认订阅[email protected]`的邮件(如果长时间没有收到,请确认邮件是否被您的邮箱屏蔽,如果有未被屏蔽,长时间会收到回复,返回步骤1
2. 等到收到一封主题为`确认订阅[email protected]`的邮件(如果长时间没有收到,请确认邮件是否被您的邮箱屏蔽,如果有未被屏蔽,长时间会收到回复,返回步骤 1
3. 直接回复电子邮件,不更改主题行或添加电子邮件内容。
4. 等到您收到一封主题为“WELCOME to [email protected]”的电子邮件。
5. 如果您收到来自(4)的邮件,则您已成功订阅该邮件。要发起讨论,您可以直接发送电子邮件至 `[email protected]`,这将发送给订阅邮件列表的每个人。
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

0 comments on commit 82acf2e

Please sign in to comment.