Skip to content

Commit

Permalink
[ISSUE #127] Fix parallel development merge conflict and optimize doc…
Browse files Browse the repository at this point in the history
…uments (#128)

* Fix failed task and image duplicate references (zh-cn)

* Fix image relative link references (en)

* sync versioned doc change

* resolve confict: remove mis-recognized as moved file

* resolve conflict: translate a doc to manually make git change

* feat: translate HTTPS doc

* sync image relative link

* unify 1.9.0 version label

* Fix mandatory values were labeled as optional in webhook docs
  • Loading branch information
Pil0tXia authored Aug 28, 2023
1 parent 9dc094d commit 4f15235
Show file tree
Hide file tree
Showing 9 changed files with 206 additions and 431 deletions.
28 changes: 13 additions & 15 deletions docs/design-document/14-https.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,30 @@
# HTTPS

1.在eventmesh-runtime 中配置
1. Configuration in eventmesh-runtime

```
eventMesh.properties(添加如下配置)
eventMesh.server.useTls.enabled=true //默认值 false
eventMesh.properties (add the following configurations)
eventMesh.server.useTls.enabled=true // Default value: false
config env varible
-Dssl.server.protocol=TLSv1.1 //默认值 TLSv1.1
-Dssl.server.cer=sChat2.jks //把文件放到启动脚本start.sh 指定的conPath目录下
Configuring environment variable
-Dssl.server.protocol=TLSv1.1 // Default value: TLSv1.1
-Dssl.server.cer=sChat2.jks // Place the file in the conPath directory specified by the startup script start.sh
-Dssl.server.pass=sNetty
```

2.在eventmesh-sdk-java 中配置
2. Configuration in eventmesh-sdk-java

```
//创建producer
LiteClientConfig eventMeshHttpClientConfig = new eventMeshHttpClientConfig();
// Create a producer
LiteClientConfig eventMeshHttpClientConfig = new LiteClientConfig();
...
//设置开启TLS
// Enable TLS
eventMeshHttpClientConfig.setUseTls(true);
LiteProducer producer = new LiteProducer(eventMeshHttpClientConfig);
//配置环境变量
-Dssl.client.protocol=TLSv1.1 //默认值 TLSv1.1
-Dssl.client.cer=sChat2.jks //把文件放到应用指定的conPath目录下
// Configure environment variables
-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
```
27 changes: 13 additions & 14 deletions docs/design-document/15-webhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ input params:
| manufacturerEventName | manufacturer event name | string | Y | null |
| contentType | http connettype | string | N | application/json |
| description | configuration instructions | string | N | null |
| secret | signature string | string | N | null |
| secret | signature string | string | Y | null |
| userName | username | string | N | null |
| password | password | string | N | null |
| cloudEventName | cloudEvent name | string | Y | null |
Expand All @@ -127,7 +127,8 @@ E.g:
"manufacturerName":"github",
"manufacturerDomain":"www.github.com",
"manufacturerEventName":"all",
"cloudEventName":"github-eventmesh"
"cloudEventName":"github-eventmesh",
"secret": "testSecret"
}
```

Expand Down Expand Up @@ -167,7 +168,7 @@ Output params:
| manufacturerEventName | manufacturer event name | string | Y | null |
| contentType | http connettype | string | N | application/json |
| description | configuration instructions | string | N | null |
| secret | signature key | string | N | null |
| secret | signature key | string | Y | null |
| userName | user name | string | N | null |
| password | password | string | N | null |
| cloudEventName | cloudEvent name | string | Y | null |
Expand Down Expand Up @@ -209,7 +210,7 @@ Output params:
| manufacturerEventName | manufacturer event name | string | Y | null |
| contentType | http connettype | string | N | application/json |
| description | configuration instructions | string | N | null |
| secret | signature key | string | N | null |
| secret | signature key | string | Y | null |
| userName | user name | string | N | null |
| password | password | string | N | null |
| cloudEventName | cloudEvent name | string | Y | null |
Expand All @@ -233,7 +234,7 @@ input params:
| manufacturerEventName | manufacturer event name | string | Y | null |
| contentType | http connettype | string | N | application/json |
| description | configuration instructions | string | N | null |
| secret | signature string | string | N | null |
| secret | signature string | string | Y | null |
| userName | username | string | N | null |
| password | password | string | N | null |
| cloudEventName | cloudEvent name | string | Y | null |
Expand All @@ -247,7 +248,8 @@ E.g:
"manufacturerName":"github",
"manufacturerDomain":"www.github.com",
"manufacturerEventName":"all",
"cloudEventName":"github-eventmesh"
"cloudEventName":"github-eventmesh",
"secret": "testSecret"
}
```

Expand Down Expand Up @@ -292,25 +294,25 @@ Output params: 1 for success, 0 for failure
## Manufacturer's Webhook operation instructions

### github sign up
### GitHub sign up

#### The first step: Enter the corresponding project

#### The second step: click setting

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

#### The third step: click Webhooks

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

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

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

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

![](/images/design-document/webhook/webhook-github-info.png)
![](../../static/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`.

Expand All @@ -319,6 +321,3 @@ Payload URL: EventMesh service address and callbackPath, which must include the
Content type: http header content type

Secret: signature string



Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ contentType: application/json
| manufacturerEventName | 厂商事件名 | string || null |
| contentType | http connettype | string || application/json |
| description | 配置说明 | string || null |
| secret | 验签密钥 | string | | null |
| secret | 验签密钥 | string | | null |
| userName | 用户名 | string || null |
| password | 用户密码 | string || null |
| cloudEventName | 事件名 | string || null |
Expand All @@ -138,7 +138,8 @@ contentType: application/json
"manufacturerName":"github",
"manufacturerDomain":"www.github.com",
"manufacturerEventName":"all",
"cloudEventName":"github-eventmesh"
"cloudEventName":"github-eventmesh",
"secret": "testSecret"
}
```

Expand Down Expand Up @@ -177,7 +178,7 @@ contentType: application/json
| manufacturerEventName | 厂商事件名 | string || null |
| contentType | http connettype | string || application/json |
| description | 配置说明 | string || null |
| secret | 验签密钥 | string | | null |
| secret | 验签密钥 | string | | null |
| userName | 用户名 | string || null |
| password | 用户密码 | string || null |
| cloudEventName | 事件名() | string || null |
Expand Down Expand Up @@ -219,7 +220,7 @@ contentType: application/json
| manufacturerEventName | 厂商事件名 | string || null |
| contentType | http connettype | string || application/json |
| description | 配置说明 | string || null |
| secret | 验签密钥 | string | | null |
| secret | 验签密钥 | string | | null |
| userName | 用户名 | string || null |
| password | 用户密码 | string || null |
| cloudEventName | 事件名() | string || null |
Expand All @@ -243,7 +244,7 @@ contentType: application/json
| manufacturerEventName | 厂商事件名 | string || null |
| contentType | http connettype | string || application/json |
| description | 配置说明 | string || null |
| secret | 验签密钥 | string | | null |
| secret | 验签密钥 | string | | null |
| userName | 用户名 | string || null |
| password | 用户密码 | string || null |
| cloudEventName | 事件名 | string || null |
Expand All @@ -257,7 +258,8 @@ contentType: application/json
"manufacturerName":"github",
"manufacturerDomain":"www.github.com",
"manufacturerEventName":"all",
"cloudEventName":"github-eventmesh"
"cloudEventName":"github-eventmesh",
"secret": "testSecret"
}
```

Expand Down Expand Up @@ -307,21 +309,21 @@ contentType: application/json

#### 第一步:进入对应的项目

#### 第二步:点击 setting
#### 第二步:点击setting

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

#### 第三步:点击 Webhooks
#### 第三步:点击Webhooks

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

#### 第四步:点击 Add Webhook
#### 第四步:点击 Add webhook

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

#### 第五步: 填写 Webhook 信息
#### 第五步: 填写webhook信息

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

Payload URL: EventMesh 服务地址和调用地址,需包含协议头。例如,当调用地址 `callbackPath``/webhook/github/eventmesh/all` 时,Payload URL 为 `http://www.example.com:10105/webhook/github/eventmesh/all`

Expand Down
2 changes: 1 addition & 1 deletion i18n/zh/docusaurus-plugin-content-docs/version-v1.9.0.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"version.label": {
"message": "1.9.0",
"message": "v1.9.0",
"description": "The label for current version"
},
"sidebar.tutorialSidebar.category.Installation and Deployment": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,30 @@
1.在eventmesh-runtime 中配置

```
eventMesh.properties(添加如下配置)
eventMesh.server.useTls.enabled=true //默认值 false
eventMesh.properties (添加如下配置)
eventMesh.server.useTls.enabled=true // 默认值 false
config env varible
-Dssl.server.protocol=TLSv1.1 //默认值 TLSv1.1
-Dssl.server.cer=sChat2.jks //把文件放到启动脚本start.sh 指定的conPath目录下
-Dssl.server.protocol=TLSv1.1 // 默认值 TLSv1.1
-Dssl.server.cer=sChat2.jks // 把文件放到启动脚本start.sh 指定的conPath目录下
-Dssl.server.pass=sNetty
```

2.在eventmesh-sdk-java 中配置

```
//创建producer
// 创建producer
LiteClientConfig eventMeshHttpClientConfig = new eventMeshHttpClientConfig();
...
//设置开启TLS
// 设置开启TLS
eventMeshHttpClientConfig.setUseTls(true);
LiteProducer producer = new LiteProducer(eventMeshHttpClientConfig);
//配置环境变量
-Dssl.client.protocol=TLSv1.1 //默认值 TLSv1.1
-Dssl.client.cer=sChat2.jks //把文件放到应用指定的conPath目录下
// 配置环境变量
-Dssl.client.protocol=TLSv1.1 // 默认值 TLSv1.1
-Dssl.client.cer=sChat2.jks // 把文件放到应用指定的conPath目录下
-Dssl.client.pass=sNetty
```

This file was deleted.

Loading

0 comments on commit 4f15235

Please sign in to comment.