Skip to content

Commit

Permalink
[ISSUE #119, #121] CN and EN content of documents of different releas…
Browse files Browse the repository at this point in the history
…e versions (#126)

* fix: git conflicts and Fixes #121

* fix: Fix #122 and Fixes #90

* fix: format

* fix: format and remove doc

* fix: add next

* fix: doc name and number
  • Loading branch information
andream7 committed Sep 3, 2023
1 parent 4f15235 commit 92c18b2
Show file tree
Hide file tree
Showing 641 changed files with 31,791 additions and 5,794 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ CNCF [Serverless Workflow](https://serverlessworkflow.io/) defines a vendor-neut

This project is composed of:

* [Specification](specification.md) for defining DSL-based workflows
* [Specification](https://github.com/serverlessworkflow/specification/blob/main/specification.md#using-functions-for-async-api-service-invocations) for defining DSL-based workflows
* [Developer SDKs](#sdks) for different programming languages
* [Workflow runtimes](#runtimes) supporting the specification
* Developer [tooling support](#tooling) for writing DSL-based workflows
Expand Down
2 changes: 1 addition & 1 deletion community/02-how-to-subscribe.md
Original file line number Diff line number Diff line change
Expand Up @@ -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](./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
3 changes: 0 additions & 3 deletions community/05-how-to-vote-a-committer-pmc.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,9 +247,6 @@ After receiving the notification email that the account was created successfully
- 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


For detailed instructions, see [PMC/Committer Related Permission Configuration](pmc-related-permission-configuration.md)

If you want to make a public appearance in the Apache GitHub organization, you need to go to the [Apache GitHub people page](https://github.com/orgs/apache/people),
Search for yourself, then select `Organization visibility` for `Public`.

Expand Down
6 changes: 3 additions & 3 deletions community/contribute/01-contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Settings -> Editor -> Code Style -> Import Scheme -> IntelliJ IDEA code style XM

#### Import CheckStyle

File location: Import the [`checkStyle.xml`](https://github.com/apache/incubator-eventmesh/blob/master/style/checkStyle.xml)file located in the `eventmesh/style` directory of the source code into **`IntelliJ IDEA`**.
File location: Import the [`checkStyle.xml`](https://github.com/apache/eventmesh/blob/master/style/checkStyle.xml)file located in the `eventmesh/style` directory of the source code into **`IntelliJ IDEA`**.

Please install the CheckStyle-IDEA plugin. For IDEA, you need to import the CheckStyle code style file in the following two settings:
```shell
Expand Down Expand Up @@ -90,7 +90,7 @@ Here are the workflow for contributors:

2. Clone fork to local repository
```git
git clone git@github.com:yourgithub/incubator-eventmesh.git
git clone git@github.com:yourgithub/eventmesh.git
```

3. Create a new branch and work on it
Expand All @@ -100,7 +100,7 @@ git checkout -b fix_patch_xx

4. Keep your branch in sync
```git
git remote add upstream git@github.com:apache/incubator-eventmesh.git
git remote add upstream git@github.com:apache/eventmesh.git
git fetch upstream master:upstream_master
git rebase upstream_master
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

#### Message Composition

The `Package` class in the [`Package.java` file](https://github.com/apache/incubator-eventmesh/blob/master/eventmesh-common/src/main/java/org/apache/eventmesh/common/protocol/tcp/Package.java) is the TCP message object used in business logic layer. The class contains the `header` and `body` fields.
The `Package` class in the [`Package.java` file](https://github.com/apache/eventmesh/blob/master/eventmesh-common/src/main/java/org/apache/eventmesh/common/protocol/tcp/Package.java) is the TCP message object used in business logic layer. The class contains the `header` and `body` fields.

```java
public class Package {
Expand Down Expand Up @@ -142,7 +142,7 @@ public enum Command {

### Protocol Format

The `EventMeshMessage` class in the [`EventMeshMessage.java` file](https://github.com/apache/incubator-eventmesh/blob/master/eventmesh-common/src/main/java/org/apache/eventmesh/common/EventMeshMessage.java) is the HTTP message definition of EventMesh Runtime.
The `EventMeshMessage` class in the [`EventMeshMessage.java` file](https://github.com/apache/eventmesh/blob/master/eventmesh-common/src/main/java/org/apache/eventmesh/common/EventMeshMessage.java) is the HTTP message definition of EventMesh Runtime.

```java
public class EventMeshMessage {
Expand Down Expand Up @@ -246,7 +246,7 @@ The request header of the Send Async message is identical to the request header

### Protobuf

The `eventmesh-protocol-gprc` module contains the [protobuf definition file](https://github.com/apache/incubator-eventmesh/blob/master/eventmesh-protocol-plugin/eventmesh-protocol-grpc/src/main/proto/eventmesh-client.proto) of the Eventmesh client. The `gradle build` command generates the gRPC codes, which are located in `/build/generated/source/proto/main`. The generated gRPC codes are used in `eventmesh-sdk-java` module.
The `eventmesh-protocol-gprc` module contains the [protobuf definition file](https://github.com/apache/eventmesh/blob/master/eventmesh-protocol-plugin/eventmesh-protocol-grpc/src/main/proto/eventmesh-client.proto) of the Eventmesh client. The `gradle build` command generates the gRPC codes, which are located in `/build/generated/source/proto/main`. The generated gRPC codes are used in `eventmesh-sdk-java` module.

### Data Model

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ LiteProducer producer = new LiteProducer(eventMeshHttpClientConfig);
-Dssl.client.protocol=TLSv1.1 // Default value: TLSv1.1
-Dssl.client.cer=sChat2.jks // Place the file in the conPath directory specified by the application
-Dssl.client.pass=sNetty
```
```
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Use Webhook to subscribe events

## Webhook usage process

### The first step: Configure Webhook related information in eventmesh and start
Expand Down Expand Up @@ -298,24 +297,24 @@ Output params: 1 for success, 0 for failure

#### The second step: click setting

![](../../../static/images/design-document/webhook/webhook-github-setting.png)
![](/images/design-document/webhook/webhook-github-setting.png)

#### The third step: click Webhooks

![](../../../static/images/design-document/webhook/webhook-github-webhooks.png)
![](/images/design-document/webhook/webhook-github-webhooks.png)

#### The fourth step: Click on Add Webhook

![](../../../static/images/design-document/webhook/webhook-github-add.png)
![](/images/design-document/webhook/webhook-github-add.png)

#### The fifth step: Fill in the Webhook information

![](../../../static/images/design-document/webhook/webhook-github-info.png)
![](/images/design-document/webhook/webhook-github-info.png)

Payload URL: EventMesh service address and callbackPath, which must include the protocol header. For example, when the callback address `callbackPath` is `/webhook/github/eventmesh/all`, the Payload URL is `http://www.example.com:10105/webhook/github/eventmesh/all`.

[http or https]://[domain or IP]:[port]/webhook/[callbackPath]

Content type: http header content type

Secret: signature string
Secret: signature string
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ We use the *cloudevents-player* [Knative service](https://knative.dev/docs/servi


### Set up EventMesh Configuration
- Add the following lines to [eventmesh-starter/build.gradle](https://github.com/apache/incubator-eventmesh/blob/master/eventmesh-starter/build.gradle) file.
- Add the following lines to [eventmesh-starter/build.gradle](https://github.com/apache/eventmesh/blob/master/eventmesh-starter/build.gradle) file.
```
plugins {
id 'application'
Expand All @@ -24,7 +24,7 @@ dependencies {
implementation project(":eventmesh-runtime")
}
```
- Add the following lines to [eventmesh-examples/build.gradle](https://github.com/apache/incubator-eventmesh/blob/master/eventmesh-examples/build.gradle) file.
- Add the following lines to [eventmesh-examples/build.gradle](https://github.com/apache/eventmesh/blob/master/eventmesh-examples/build.gradle) file.
```
plugins {
id 'application'
Expand All @@ -34,7 +34,7 @@ application {
mainClass = project.hasProperty("mainClass") ? project.getProperty("mainClass") : 'NULL'
}
```
- Set ```eventMesh.connector.plugin.type=knative``` in [eventmesh-runtime/conf/eventmesh.properties](https://github.com/pchengma/incubator-eventmesh/blob/master/eventmesh-runtime/conf/eventmesh.properties) file.
- Set ```eventMesh.connector.plugin.type=knative``` in [eventmesh-runtime/conf/eventmesh.properties](https://github.com/apache/eventmesh/blob/master/eventmesh-runtime/conf/eventmesh.properties

## Demo
### Publish an Event Message from Knative and Subscribe from EventMesh
Expand All @@ -50,7 +50,7 @@ $ curl -i http://cloudevents-player.default.127.0.0.1.sslip.io -H "Content-Type:
```

#### Step 3: Subscribe from an EventMesh
- Set ```public static final String EVENTMESH_HTTP_ASYNC_TEST_TOPIC = "messages";``` in [ExampleConstants.java](https://github.com/apache/incubator-eventmesh/blob/master/eventmesh-examples/src/main/java/org/apache/eventmesh/common/ExampleConstants.java) file.
- Set ```public static final String EVENTMESH_HTTP_ASYNC_TEST_TOPIC = "messages";``` in [ExampleConstants.java](https://github.com/apache/eventmesh/blob/master/eventmesh-examples/src/main/java/org/apache/eventmesh/common/ExampleConstants.java) file.
```bash
$ cd eventmesh-examples
$ ../gradlew -PmainClass=org.apache.eventmesh.http.demo.sub.SpringBootDemoApplication run
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Event Handling and Integration",
"collapsed": false
}
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Introduction

[EventMesh(incubating)](https://github.com/apache/incubator-eventmesh) is a dynamic cloud-native eventing infrastructure.
[EventMesh](https://github.com/apache/eventmesh) is a dynamic cloud-native eventing infrastructure.

## An overview of OpenTelemetry

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 4 additions & 0 deletions docs/design-document/02-observability/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Observability",
"collapsed": false
}
File renamed without changes.
File renamed without changes.
38 changes: 21 additions & 17 deletions docs/instruction/00-eclipse.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,42 @@
# Import EventMesh into eclipse

我们推荐使用 `Intellij IDEA` 进行开发,如果您希望使用 `Eclipse`,可以参考下面的步骤导入项目。
We recommend using `Intellij IDEA` for development, if you wish to use `Eclipse`, you can refer to the following steps to import the project.

### 依赖
### 1. Dependencies

```
64位JDK 1.8+;
Gradle至少为7.0, 推荐 7.0.*
eclipse 已安装gradle插件或者eclipse自带gradle插件
64-bit JDK 1.8+.
Gradle is at least 7.0, 7.0.* recommended;
eclipse installed gradle plugin or eclipse comes with gradle plugin;
```

### 下载源码
### 2. Download source code

git init

git clone <https://github.com/apache/incubator-eventmesh.git>
```shell
git@github.com:apache/eventmesh.git
```

### 项目编译eclipse环境
### 3. Project compile eclipse environment

打开命令行终端,运行gradlew cleanEclipse eclipse
Open a command line terminal and run `gradlew cleanEclipse eclipse`

### 配置修改
### 4. Configuration changes

修改工程名称和settings.gradle 配置文件参数rootProject.name 参数一致
Modify the project name to match the `settings.gradle` configuration file parameter `rootProject.name`.

### 修改eclipse.init配置文件,配置lombok以1.18.8版本为例
### 5. Modify `eclipse.init` configuration file, configure lombok to 1.18.8 version for example

```
-javaagent:lombok-1.18.8.jar
-XBootclasspath/a:lombok-1.18.8.jar
```

### 202106版本eclipse,eclipse.init增加配置参数
### 6. 202106 version, `eclipse.init` add configuration parameters

```
--illegal-access=permit
```

### 导入gradle
### 7. Import projetc

打开eclipse,导入gradle项目到IDE里
Open eclipse, import gradle project to IDE.
28 changes: 16 additions & 12 deletions docs/instruction/01-store.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
# EventMesh Store

## Dependencies
If you choose standalone mode, you could skip this file and go to the next step: Start Eventmesh-Runtime; if not, you could choose RocketMQ as the store layer.

## 1. Dependencies

```text
64-bit OS,we recommend Linux/Unix;
64-bit JDK 1.8+;
Gradle 7.0+, we recommend 7.0.*
4g+ available disk to deploy eventmesh-store
If you choose standalone mode, you could skip this file and go to the next step: Start Eventmesh-Runtime; if not, you could choose RocketMQ as the store layer.
Gradle 7.0+, we recommend 7.0.*;
4g+ available disk to deploy eventmesh-store;
```

## Download
## 2. Binary Deployment

### 2.1 Downloa

Download the Binary code (recommended: 4.9.*) from [RocketMQ Official](https://rocketmq.apache.org/download/). Here we take 4.9.4 as an example.

Expand All @@ -19,24 +22,25 @@ unzip rocketmq-all-4.9.4-bin-release.zip
cd rocketmq-4.9.4/
```

## Deploy
![rocketmq_1](/images/install/rocketmq_1.png)

### Start Name Server
### 2.2 Start

Start Name Server:

```console
nohup sh bin/mqnamesrv &
tail -f ~/logs/rocketmqlogs/namesrv.log
```

### Start Broker
![rocketmq_2](/images/install/rocketmq_2.png)

Start Broker:

```console
nohup sh bin/mqbroker -n localhost:9876 &
tail -f ~/logs/rocketmqlogs/broker.log
```

The deployment of eventmesh-store has finished, please go to the next step: [Start Eventmesh-Runtime](02-runtime.md)

## Reference
![rocketmq_3](/images/install/rocketmq_3.png)

For more details about RocketMQ, please refer to <https://rocketmq.apache.org/docs/quick-start/>
59 changes: 47 additions & 12 deletions docs/instruction/02-store-with-docker.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
# EventMesh Store with Docker

## Dependencies
If you choose standalone mode, you could skip this file and go to the next step: Start Eventmesh-Runtime; if not, you could choose RocketMQ as the store layer.

## 1. Dependencies

```
64-bit OS,we recommend Linux/Unix;
64-bit JDK 1.8+;
Gradle 7.0+, we recommend 7.0.*
4g+ available disk to deploy eventmesh-store
If you choose standalone mode, you could skip this file and go to the next step: Start Eventmesh-Runtime; if not, you could choose RocketMQ as the store layer.
```

## Deploy
## 2. Deploy

### 2.1 Pull Images

Pull RocketMQ image from Docker Hub:

Expand All @@ -19,20 +22,52 @@ Pull RocketMQ image from Docker Hub:
sudo docker pull apache/rocketmq:4.9.4
```

Start namesrv and broker
You can list and view existing local mirrors with the following command:

```shell
#Run namerv container
sudo docker run -d -p 9876:9876 -v `pwd`/data/namesrv/logs:/root/logs -v `pwd`/data/namesrv/store:/root/store --name rmqnamesrv apache/rocketmq:4.9.4 sh mqnamesrv
sudo docker images
```

If the terminal displays the image information as shown below, the EventMesh image has been successfully downloaded locally.

#Run broker container
sudo docker run -d -p 10911:10911 -p 10909:10909 -v `pwd`/data/broker/logs:/root/logs -v `pwd`/data/broker/store:/root/store --name rmqbroker --link rmqnamesrv:namesrv -e "NAMESRV_ADDR=namesrv:9876" apache/rocketmq:4.9.4 sh mqbroker -c ../conf/broker.conf
```shell
REPOSITORY TAG IMAGE ID CREATED SIZE
apache/rocketmq 4.9.4 a2a50ca263c3 13 months ago 548MB
```

Please note that the **rocketmq-broker ip** is **pod ip**. If you want to modify this ip, you can set it your custom value in **broker.conf**
![rocketmq_docker_1](/images/install/rocketmq_docker_1.png)

### 2.2 Run Docker

By now, the deployment of eventmesh-store has finished, please go to the next step: [Start Eventmesh-Runtime Using Docker](02-runtime-with-docker.md)
Run namerv container:

```shell

## Reference
sudo docker run -d -p 9876:9876 \
-v `pwd`/data/namesrv/logs:/root/logs \
-v `pwd`/data/namesrv/store:/root/store \
--name rmqnamesrv \
apache/rocketmq:4.9.4 \
sh mqnamesrv

```

Run broker container:

```shell
sudo docker run -d -p 10911:10911 -p 10909:10909 \
-v `pwd`/data/broker/logs:/root/logs \
-v `pwd`/data/broker/store:/root/store \
--name rmqbroker \
--link rmqnamesrv:namesrv \
-e "NAMESRV_ADDR=namesrv:9876" \
apache/rocketmq:4.9.4 \
sh mqbroker -c ../conf/broker.conf

```

![rocketmq_docker_2](/images/install/rocketmq_docker_2.png)

Please note that the **rocketmq-broker ip** is **pod ip**. If you want to modify this ip, you can set it your custom value in **broker.conf**

For more details about RocketMQ,please refer to <https://rocketmq.apache.org/docs/quick-start/>
By now, the deployment of eventmesh-store has finished, please go to the next step: [Start Eventmesh-Runtime Using Docker](04-runtime-with-docker.md)
Loading

0 comments on commit 92c18b2

Please sign in to comment.