Skip to content

Commit

Permalink
Fix used Chinese punctuation, spaces in the English contents. (#227)
Browse files Browse the repository at this point in the history
* Fix used Chinese punctuation, spaces in the English contents.

* Update 02-how-to-subscribe.md

* Update 04-release.md
  • Loading branch information
huacnlee committed Jun 22, 2024
1 parent 927fa7c commit 4432a12
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 23 deletions.
1 change: 1 addition & 0 deletions .autocorrectignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
versioned_docs/
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 dev@eventmesh.apache.org mailing list**

The steps are as follows
1. Send an email without any content or subject: `dev-subscribe@eventmesh.apache.org`
2. Wait until you receive an email with the subject line `confirm subscribe to dev@eventmesh.apache.org` (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: `dev-subscribe@eventmesh.apache.org`.
2. Wait until you receive an email with the subject line `confirm subscribe to dev@eventmesh.apache.org` (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 dev@eventmesh.apache.org` .
4. Wait until you receive an email with the subject line `WELCOME to dev@eventmesh.apache.org`.
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 `dev@eventmesh.apache.org`, 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: `dev-unsubscribe@eventmesh.apache.org`
2. Wait until you receive an email with the subject line `confirm unsubscribe from dev@eventmesh.apache.org`
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 dev@eventmesh.apache.org`
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: `dev-unsubscribe@eventmesh.apache.org`.
2. Wait until you receive an email with the subject line `confirm unsubscribe from dev@eventmesh.apache.org`.
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 dev@eventmesh.apache.org`.
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 `xxx@apache.org` 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

0 comments on commit 4432a12

Please sign in to comment.