You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@eventmesh.apache.org by xi...@apache.org on 2023/02/01 03:29:20 UTC
[incubator-eventmesh-site] branch master updated: fix: fetch zh documentation
This is an automated email from the ASF dual-hosted git repository.
xiaoyang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-eventmesh-site.git
The following commit(s) were added to refs/heads/master by this push:
new 00caf82e fix: fetch zh documentation
new a5597acc Merge remote-tracking branch 'origin/master'
00caf82e is described below
commit 00caf82e85453c3acec33bb329c759c5b8bb5b37
Author: Xiaoyang Liu <si...@gmail.com>
AuthorDate: Tue Jan 31 19:28:32 2023 -0800
fix: fetch zh documentation
Signed-off-by: Xiaoyang Liu <si...@gmail.com>
---
docs/design-document/01-workflow.md | 6 +-
docs/design-document/02-runtime-protocol.md | 6 +-
docs/design-document/03-stream.md | 10 +-
docs/design-document/04-schema-registry.md | 6 +-
docs/design-document/06-cloudevents.md | 2 +-
docs/design-document/09-event-bridge.md | 6 +-
docs/design-document/14-webhook.md | 14 +-
docs/introduction.md | 48 +++++--
docs/roadmap.md | 4 +-
.../{02-release.md => current/04-release.md} | 2 -
.../current.json | 6 +
.../contribute/03-new-contributor-guidelines.md | 144 ++++++++++-----------
.../current/design-document/01-workflow.md | 6 +-
.../current/design-document/02-runtime-protocol.md | 8 +-
.../current/design-document/03-stream.md | 10 +-
.../current/design-document/06-cloudevents.md | 2 +-
.../current/design-document/09-event-bridge.md | 6 +-
.../current/design-document/11-prometheus.md | 10 --
.../design-document/{15-https.md => 14-https.md} | 0
.../{14-webhook.md => 15-webhook.md} | 10 +-
.../current/introduction.md | 13 +-
static/images/contribute/checkstyle01.png | Bin 0 -> 33655 bytes
static/images/contribute/checkstyle02.png | Bin 0 -> 70777 bytes
static/images/contribute/checkstyle03.png | Bin 0 -> 22465 bytes
static/images/contribute/checkstyle04.png | Bin 0 -> 72858 bytes
static/images/contribute/checkstyle05.png | Bin 0 -> 33282 bytes
static/images/contribute/checkstyle06.png | Bin 0 -> 25716 bytes
static/images/contribute/zh/contribute01.png | Bin 0 -> 4398 bytes
static/images/contribute/zh/contribute02.png | Bin 0 -> 151991 bytes
static/images/contribute/zh/contribute03.png | Bin 0 -> 500195 bytes
static/images/contribute/zh/contribute04.png | Bin 0 -> 60638 bytes
static/images/contribute/zh/contribute05.png | Bin 0 -> 24205 bytes
static/images/contribute/zh/contribute06.png | Bin 0 -> 2583 bytes
static/images/contribute/zh/contribute07.png | Bin 0 -> 66263 bytes
static/images/contribute/zh/contribute08.png | Bin 0 -> 17845 bytes
static/images/contribute/zh/contribute09.png | Bin 0 -> 291029 bytes
static/images/contribute/zh/contribute10.png | Bin 0 -> 99765 bytes
static/images/contribute/zh/contribute11.png | Bin 0 -> 287293 bytes
static/images/contribute/zh/contribute12.png | Bin 0 -> 13565 bytes
static/images/contribute/zh/contribute13.png | Bin 0 -> 50915 bytes
static/images/contribute/zh/contribute14.png | Bin 0 -> 51475 bytes
static/images/contribute/zh/contribute15.png | Bin 0 -> 54067 bytes
static/images/contribute/zh/contribute16.png | Bin 0 -> 25131 bytes
static/images/contribute/zh/contribute17.png | Bin 0 -> 41823 bytes
static/images/dashboard.png | Bin 0 -> 617279 bytes
.../images/design-document/event-bridge-detail.png | Bin 0 -> 563043 bytes
static/images/design-document/tcp-protocol.png | Bin 0 -> 52135 bytes
.../design-document/webhook/webhook-github-add.png | Bin 0 -> 82039 bytes
.../webhook/webhook-github-info.png | Bin 0 -> 49447 bytes
.../webhook/webhook-github-setting.png | Bin 0 -> 26731 bytes
.../webhook/webhook-github-webhooks.png | Bin 0 -> 49447 bytes
51 files changed, 160 insertions(+), 159 deletions(-)
diff --git a/docs/design-document/01-workflow.md b/docs/design-document/01-workflow.md
index fecae1ee..43589178 100644
--- a/docs/design-document/01-workflow.md
+++ b/docs/design-document/01-workflow.md
@@ -6,7 +6,7 @@ Imaging you are building a simple Order Management System for an E-Commerce Stor
For high availability and high performance, you architect the system using event-driven architecture (EDA), and build microservice apps to handle store frontend, order management, payment processing, and shipment management. You deploy the whole system in a cloud environment. To handle high workloads, you leverage a messaging system to buffer the loads, and scale up multiple instances of microservices. The architecture could look similar to:
-
+
While each microservice is acting on its own event channels, EventMesh plays a crucial role of doing Event Orchestration.
@@ -181,13 +181,13 @@ events:
The corresponding workflow diagram is the following:
-
+
## EventMesh Workflow Engine
In the following architecture diagram, the EventMesh Catalog, EventMesh Workflow Engine and EventMesh Runtime are running in three different processors.
-
+
The steps running the workflow is the followings:
diff --git a/docs/design-document/02-runtime-protocol.md b/docs/design-document/02-runtime-protocol.md
index b992bf89..0b213b7e 100644
--- a/docs/design-document/02-runtime-protocol.md
+++ b/docs/design-document/02-runtime-protocol.md
@@ -128,15 +128,15 @@ public enum Command {
#### Sync Message
-
+
#### Async Message
-
+
#### Boardcast Message
-
+
## HTTP Protocol
diff --git a/docs/design-document/03-stream.md b/docs/design-document/03-stream.md
index d379ccdd..7f2534a5 100644
--- a/docs/design-document/03-stream.md
+++ b/docs/design-document/03-stream.md
@@ -36,7 +36,7 @@ and easily integrate various systems consuming or producing data.
## Architecture
-
+
## Design
@@ -83,7 +83,7 @@ The main advantage of the pipeline is that you can create complex event processi
Component interface is the primary entry point, you can use Component object as a factory to create EndPoint objects.
-
+
### EndPoint
@@ -92,14 +92,14 @@ EndPoint which is act as factories for creating Consumer, Producer and Event obj
- `createConsumer()` — Creates a consumer endpoint, which represents the source endpoint at the beginning of a route.
- `createProducer()` — Creates a producer endpoint, which represents the target endpoint at the end of a route.
-
+
#### Producer
User can create following types of producer
> Synchronous Producer-Processing thread blocks until the producer has finished the event processing.
-
+
In future Producer Types:
@@ -110,7 +110,7 @@ In future Producer Types:
User can create following types of consumer
> Event-driven consumer-the processing of an incoming request is initiated when message binder call a method in consumer.
-
+
In the Future
diff --git a/docs/design-document/04-schema-registry.md b/docs/design-document/04-schema-registry.md
index 5c0b65f9..7c5d2282 100644
--- a/docs/design-document/04-schema-registry.md
+++ b/docs/design-document/04-schema-registry.md
@@ -39,11 +39,11 @@ OpenSchema[[5]](#References) proposes a specification for data schema when excha
### Architecture
-
+
### Process of Transferring Messages under Schema Registry
-
+
The highlevel process of messages transmission contains 10 steps as follows:
@@ -119,7 +119,7 @@ No. | Type | URL | response | exception | code | test
```CompatibilityController.java```+```CompatibilityService.java``` : ```OpenSchema 7.3.1~7.3.3 (API 11~13)``` + ```Check for Compatibility```
-
+
## References
diff --git a/docs/design-document/06-cloudevents.md b/docs/design-document/06-cloudevents.md
index 20a99d18..bff91b45 100644
--- a/docs/design-document/06-cloudevents.md
+++ b/docs/design-document/06-cloudevents.md
@@ -44,7 +44,7 @@ should be an easy way to achieve the requirements.
### Pluggable Protocols
-
+
### Process of CloudEvents under EventMesh
diff --git a/docs/design-document/09-event-bridge.md b/docs/design-document/09-event-bridge.md
index b74b78e0..0bacec28 100644
--- a/docs/design-document/09-event-bridge.md
+++ b/docs/design-document/09-event-bridge.md
@@ -1,10 +1,10 @@
# Event Bridge
-
+
Event Bridge 可以支持跨mesh集群的消息投递，下面展示这一功能的详细设计与体验步骤
-
+
> 注：在本地体验这一功能时需要启动两台eventmesh实例，同时要修改`eventmesh-runtime`目录下的`eventmesh.properties`文件中的端口配置，避免端口冲突。便于下文描述，event-bridge特性按照上图信息进行表述。
@@ -153,4 +153,4 @@ Event Bridge 可以支持跨mesh集群的消息投递，下面展示这一功能
"TEST-TOPIC-HTTP-ASYNC"
]
}
-```
\ No newline at end of file
+```
diff --git a/docs/design-document/14-webhook.md b/docs/design-document/14-webhook.md
index be7120e8..02f4bcf1 100644
--- a/docs/design-document/14-webhook.md
+++ b/docs/design-document/14-webhook.md
@@ -98,7 +98,7 @@ path: /webhook/insertWebHookConfig
method: POST
contentType: application/json
-input params:
+input params:
| field | desc | type | necessary | default |
| -- | -- | -- | -- | -- |
| callbackPath | call address, unique address | string | Y | null |
@@ -135,7 +135,7 @@ path: /webhook/deleteWebHookConfig
method: POST
contentType： application/json
-input params:
+input params:
| field | desc | type | necessary | default |
| -- | -- | -- | -- | -- |
| callbackPath | call address, unique address | string | Y | null |
@@ -230,7 +230,7 @@ Output params:
#### The third step: Check if the configuration is successful
1. file storage mode. Please go to the eventMesh.webHook.fileMode.filePath directory to view. filename callbackPath.
-
+
2. nacos storage mode. Please go to the nacos service configured by eventMesh.webHook.nacosMode.serverAddr to see.
#### The fourth step: Configure the consumer of cloudevent
@@ -247,19 +247,19 @@ Output params:
#### The second step: click setting
-
+
#### The third step: click Webhooks
-
+
#### The fourth step: Click on Add webhook
-
+
#### The fifth step: Fill in the webhook information
-
+
Payload URL: Service address and pahts. [http or https]://[domain or IP]:[port]/webhook/[callbackPath]
Content type: http header content type
diff --git a/docs/introduction.md b/docs/introduction.md
index 6d1891cf..991f81e1 100644
--- a/docs/introduction.md
+++ b/docs/introduction.md
@@ -4,19 +4,39 @@ sidebar_position: 0
# Introduction to EventMesh
-**Apache EventMesh (Incubating)** is a fully serverless platform used to build distributed event-driven applications.
+[](https://github.com/apache/incubator-eventmesh/actions/workflows/ci.yml)
+[](https://codecov.io/gh/apache/incubator-eventmesh)
+[](https://lgtm.com/projects/g/apache/incubator-eventmesh/context:java)
+[](https://lgtm.com/projects/g/apache/incubator-eventmesh/alerts/)
+[](https://www.apache.org/licenses/LICENSE-2.0.html)
+[](https://github.com/apache/incubator-eventmesh/releases)
+[](https://join.slack.com/t/apacheeventmesh/shared_invite/zt-16y1n77va-q~JepYy3RqpkygDYmQaQbw)
+
+**Apache EventMesh (Incubating)** is a dynamic event-driven application runtime used to decouple the application and backend middleware layer, which supports a wide range of use cases that encompass complex multi-cloud, widely distributed topologies using diverse technology stacks.
+
## Features
-Apache EventMesh (Incubating) has a vast amount of features to help users achieve their goals. Let us share with you some of the key features EventMesh has to offer:
-
-- Built around the [CloudEvents](https://cloudevents.io) specification.
-- Rapidty extendsible language sdk around [gRPC](https://grpc.io) protocols.
-- Rapidty extendsible middleware by connectors such as [Apache RocketMQ](https://rocketmq.apache.org), [Apache Kafka](https://kafka.apache.org), [Apache Pulsar](https://pulsar.apache.org), [RabbitMQ](https://rabbitmq.com), [Redis](https://redis.io), [Pravega](https://cncf.pravega.io), and [RDMS](https://en.wikipedia.org/wiki/Relational_database)(in progress) using [JDBC](https://en.wikipedia.org/wiki/Java_Database_Connectivity).
-- Rapidty extendsible controller such as [Consul](https://consulproject.org/en/), [Nacos](https://nacos.io), [ETCD](https://etcd.io) and [Zookeeper](https://zookeeper.apache.org/).
-- Guaranteed at-least-once delivery.
-- Deliver events between multiple EventMesh deployments.
-- Event schema management by catalog service.
-- Powerful event orchestration by [Serverless workflow](https://serverlessworkflow.io/) engine.
-- Powerful event filtering and transformation.
-- Rapid, seamless scalability.
-- Easy Function develop and framework integration.
+- **Communication Protocol**: EventMesh could communicate with clients with TCP, HTTP, or gRPC.
+- **CloudEvents**: EventMesh supports the [CloudEvents](https://cloudevents.io) specification as the format of the events. CloudEvents is a specification for describing event data in common formats to provide interoperability across services, platforms, and systems.
+- **Schema Registry**: EventMesh implements a schema registry that receives and stores schemas from clients and provides an interface for other clients to retrieve schemas.
+- **Observability**: EventMesh exposed a range of metrics, such as the average latency of the HTTP protocol and the number of delivered messages. The metrics could be collected and analyzed with Prometheus or OpenTelemetry.
+- **Event Workflow Orchestration**: EventMesh Workflow could receive an event and decide which command to trigger next based on the workflow definitions and the current workflow state. The workflow definition could be written with the [Serverless Workflow](https://serverlessworkflow.io) DSL.
+
+## Components
+
+Apache EventMesh (Incubating) consists of multiple components that integrate different middlewares and messaging protocols to enhance the functionalities of the application runtime.
+
+- **eventmesh-runtime**: The middleware that transmits events between producers and consumers, which supports cloud-native apps and microservices.
+- **eventmesh-sdk-java**: The Java SDK that supports HTTP, TCP, and [gRPC](https://grpc.io) protocols.
+- **eventmesh-connector-plugin**: The collection of plugins that connects middlewares such as [Apache Kafka](https://kafka.apache.org), [Apache RocketMQ](https://rocketmq.apache.org), [Apache Pulsar](https://pulsar.apache.org/), and [Redis](https://redis.io).
+- **eventmesh-registry-plugin**: The collection of plugins that integrate service registries such as [Nacos](https://nacos.io) and [etcd](https://etcd.io).
+- **eventmesh-security-plugin**: The collection of plugins that implement security mechanisms, such as ACL (access control list), authentication, and authorization.
+- **eventmesh-protocol-plugin**: The collection of plugins that implement messaging protocols, such as [CloudEvents](https://cloudevents.io) and [MQTT](https://mqtt.org).
+- **eventmesh-admin**: The control plane that manages clients, topics, and subscriptions.
+
+## Contributors
+
+Each contributor has played an important role in promoting the robust development of Apache EventMesh (Incubating). We sincerely appreciate all contributors who have contributed code and documents. The following is the list of contributors in EventMesh-related repositories.
+
+- [apache/incubator-eventmesh](https://github.com/apache/incubator-eventmesh/graphs/contributors)
+- [apache/incubator-eventmesh-site](https://github.com/apache/incubator-eventmesh-site/graphs/contributors)
diff --git a/docs/roadmap.md b/docs/roadmap.md
index 0b173473..193c1be6 100644
--- a/docs/roadmap.md
+++ b/docs/roadmap.md
@@ -39,11 +39,11 @@ The development roadmap of Apache EventMesh (Incubating) is an overview of the p
| **Implemented in 1.7.0** | Support Zookeeper | [GitHub Issue](https://github.com/apache/incubator-eventmesh/issues/417) |
| **Implemented in 1.7.0** | Support RabbitMQ as EventStore | [GitHub Issue](https://github.com/apache/incubator-eventmesh/issues/1553) |
| **Implemented in 1.8.0** | Provide Dashboard | [GitHub Issue](https://github.com/apache/incubator-eventmesh/issues/700), [GSoC '22](https://issues.apache.org/jira/browse/COMDEV-465)
-| **In Progress** | Support Filter and transform | [GitHub Issue](https://github.com/apache/incubator-eventmesh/issues/664) |
+| **In Progress** | Filter and transform | [GitHub Issue](https://github.com/apache/incubator-eventmesh/issues/664) |
| **In Progress** | Metadata consistency persistent | [GitHub Issue](https://github.com/apache/incubator-eventmesh/issues/817) |
+| Planned | Transaction Event | [GitHub Issue](https://github.com/apache/incubator-eventmesh/issues/697) |
| Planned | Provide NodeJS SDK | [GitHub Issue](https://github.com/apache/incubator-eventmesh/issues/417) |
| Planned | Provide PHP SDK | [GitHub Issue](https://github.com/apache/incubator-eventmesh/issues/1193) |
-| Planned | Transaction Event | [GitHub Issue](https://github.com/apache/incubator-eventmesh/issues/697) |
| Planned | Event Query Language (EQL) | [GitHub Issue](https://github.com/apache/incubator-eventmesh/issues/778) |
| Planned | WebAssembly Runtime | [GitHub Issue](https://github.com/apache/incubator-eventmesh/issues/576) |
diff --git a/i18n/zh/docusaurus-plugin-content-docs-community/02-release.md b/i18n/zh/docusaurus-plugin-content-docs-community/current/04-release.md
similarity index 99%
rename from i18n/zh/docusaurus-plugin-content-docs-community/02-release.md
rename to i18n/zh/docusaurus-plugin-content-docs-community/current/04-release.md
index eaf7b1a6..5d33b272 100644
--- a/i18n/zh/docusaurus-plugin-content-docs-community/02-release.md
+++ b/i18n/zh/docusaurus-plugin-content-docs-community/current/04-release.md
@@ -1,6 +1,5 @@
# Apache 发布指南
-
## 理解 Apache 发布的内容和流程
Source Release 是 Apache 关注的重点，也是发布的必须内容；而 Binary Release 是可选项，
@@ -11,7 +10,6 @@ Source Release 是 Apache 关注的重点，也是发布的必须内容；而 Bi
- [Apache Release Policy](http://www.apache.org/dev/release.html)
- [Maven Release Info](http://www.apache.org/dev/publishing-maven-artifacts.html)
-
## 本地构建环境准备
主要包括签名工具、Maven 仓库认证相关准备
diff --git a/i18n/zh/docusaurus-plugin-content-docs-team/current.json b/i18n/zh/docusaurus-plugin-content-docs-team/current.json
new file mode 100644
index 00000000..dd30528d
--- /dev/null
+++ b/i18n/zh/docusaurus-plugin-content-docs-team/current.json
@@ -0,0 +1,6 @@
+{
+ "version.label": {
+ "message": "Next",
+ "description": "The label for version current"
+ }
+}
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/contribute/03-new-contributor-guidelines.md b/i18n/zh/docusaurus-plugin-content-docs/current/contribute/03-new-contributor-guidelines.md
index 5a8e4299..0564a132 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/contribute/03-new-contributor-guidelines.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/contribute/03-new-contributor-guidelines.md
@@ -25,40 +25,40 @@
您也可以使用`./gradlew check`来检查代码风格。
(注意：这个命令将检查项目中的所有文件，当您提交一个项目时，CI将只检查这个项目中被修改的文件）。
-
+
CheckStyle-IDEA插件导入演示：
-a.如图安装CheckStyle-IDEA插件
+a.如图安装CheckStyle-IDEA插件
-
+
-b.下载完成后需要导入EventMesh的检查样式文件，如下步骤：
+b.下载完成后需要导入EventMesh的检查样式文件，如下步骤：
-1.如图：
+1.如图：
-
+
-2.当点击+号之后会出现以下界面
+2.当点击+号之后会出现以下界面
-
+
标号1的地方简单取个名字即可，标号2的地方是EventMesh CheckStyle文件的位置，在项目的style文件夹下。
-3.点击finish之后就会出现下图界面
+3.点击finish之后就会出现下图界面
-
+
将添加的样式检查文件勾选上并Apply
c.当完成以上步骤之后就可以在您完成代码编写后进行样式检查了，步骤如下：
-1.选择添加的EM-checks文件。
+1.选择添加的EM-checks文件。
-
+
-2.点击这两个地方都可检查文件样式
+2.点击这两个地方都可检查文件样式
-
+
这两个标号都只检测当前页的文件样式，标号2在当前页鼠标右键即可出现。
@@ -66,44 +66,44 @@ c.当完成以上步骤之后就可以在您完成代码编写后进行样式检
以下是贡献者提交代码的工作流程:
-0. 在提交PR之前需要先创建一个ISSUE，它是用来表达你的想法的，比如你发现了代码中的bug，想修复这个bug，那么需要告知社区管理者或贡献者你的想法，就要创建一个ISSUE用于交流讨论。在EventMesh社区有ISSUE模板，可根据您提出的ISSUE中讨论的内容使用相应的模板。
+0. 在提交PR之前需要先创建一个ISSUE，它是用来表达你的想法的，比如你发现了代码中的bug，想修复这个bug，那么需要告知社区管理者或贡献者你的想法，就要创建一个ISSUE用于交流讨论。在EventMesh社区有ISSUE模板，可根据您提出的ISSUE中讨论的内容使用相应的模板。
+
+ISSUE创建示例:
+ a.进入到项目仓库的主页，切换到issue标签，点击New issue
+ 
-ISSUE创建示例:
- a.进入到项目仓库的主页，切换到issue标签，点击New issue
- 
-
- b.就会出现下图界面
- 
+ b.就会出现下图界面
+ 
根据你的需要选择不同的ISSUE模板，如果你觉得没有模板合适，你可以选择打开一个空白模板。
- 当前EventMesh提供了六种ISSUE模板
- Bug report: 发现代码bug，请使用此模板
- Documentation Related: 文档相关的，请使用此模板
- Enhancement Request: 代码优化，增强代码实现的，请使用此模板
- Feature Request: 为EventMesh提供新的特性功能的使用此模板
- Question: 对于EventMesh有疑问的，或者有什么不明白的想要提问的，请使用此模板
- Unit Test: 想为EventMesh做一些单元测试的，请使用此模板
-
+ 当前EventMesh提供了六种ISSUE模板
+ Bug report: 发现代码bug，请使用此模板
+ Documentation Related: 文档相关的，请使用此模板
+ Enhancement Request: 代码优化，增强代码实现的，请使用此模板
+ Feature Request: 为EventMesh提供新的特性功能的使用此模板
+ Question: 对于EventMesh有疑问的，或者有什么不明白的想要提问的，请使用此模板
+ Unit Test: 想为EventMesh做一些单元测试的，请使用此模板
+
c.根据模板的提示，完成issue内容填写。主要是描述清楚问题所在和解决方案就可以了
-
- [ISSUE实例](https://github.com/apache/incubator-eventmesh/issues/2148)
- 如图：
- 
+
+ [ISSUE实例](https://github.com/apache/incubator-eventmesh/issues/2148)
+ 如图：
+ 
ISSUE与PR关联：
后续提交PR的时候，PR的标题和内容应该跟ISSUE完成关联，这样才符合开源的规范，如下图所示
-
- 
-
+
+ 
+
上图ISSUE编号为2148，那么你的PR标题前就是 [ISSUE #2148]，这样就关联上了。
-1. 在issue创建完成后，将源仓库的项目eventmesh fork到自己仓库当中
-例：
- a.点击eventmesh右上角的fork
- 
+1. 在issue创建完成后，将源仓库的项目eventmesh fork到自己仓库当中
+例：
+ a.点击eventmesh右上角的fork
+ 
b.就会出现下图，点击Create fork即可将eventmesh fork到自己的仓库
- 
-
+ 
+
2. fork完成后，克隆自己仓库的代码到本地
```git
@@ -122,7 +122,7 @@ git fetch upstream master:upstream_master
git rebase upstream_master
```
-5. 提交您的修改（确保您的提交信息简洁明了）
+5. 提交您的修改（确保您的提交信息简洁明了）
**特别注意：在提交代码之前要确保你提交代码的邮箱要与GitHub邮箱一致，不然在统计contributor数量时会发生无法正常计入的情况**
@@ -130,44 +130,44 @@ git rebase upstream_master
```git
git config --global --list
```
-如图：
-
-如果你在提交之前还未登陆邮箱，使用注册GitHub账号时的邮箱
+如图：
+
+如果你在提交之前还未登陆邮箱，使用注册GitHub账号时的邮箱
- 如果你发现你的邮箱与GitHub邮箱不一致可通过以下git命令进行修改
```git
git config --global user.name 你的目标用户名
git config --global user.email 你的目标邮箱名
```
-如图：
-
+如图：
+
修改邮箱同理(也可以用这个命令来登陆邮箱)
-例：用IDEA提交代码为例，如果您在IDEA本地修改完毕
+例：用IDEA提交代码为例，如果您在IDEA本地修改完毕
a.点击Commit，点击图片中两个地方中任意一个即可
- 
- b.就会出现以下图中界面
- 
- （注：如果是新添加的文件需要Add一下，再Commit，一般IDEA都会提示，如果没有提示，按下图操作即可，文件由红色变为绿色Add成功）
- 
-
-6. 将您的提交推送到自己的fork仓库
- a.需要push到远程仓库中，注意是您自己的仓库，您需要点击
- 
- 或者是
- 
- b.就会出现以下界面，确认无误后点击右下角push，就push到自己的仓库了
- 
- c.当您成功push到自己仓库就会出现下图的提示（在IDEA界面的右下角）
- 
-
-7. 创建一个Pull Request (PR)
-例：
- a.当您成功push到自己的仓库当中后，进入自己的仓库主页，会出现下图界面
- 
- b.点击Compare & pull request，就会出现以下界面，按照图中操作即可创建pull request
- 
-
+ 
+ b.就会出现以下图中界面
+ 
+ （注：如果是新添加的文件需要Add一下，再Commit，一般IDEA都会提示，如果没有提示，按下图操作即可，文件由红色变为绿色Add成功）
+ 
+
+6. 将您的提交推送到自己的fork仓库
+ a.需要push到远程仓库中，注意是您自己的仓库，您需要点击
+ 
+ 或者是
+ 
+ b.就会出现以下界面，确认无误后点击右下角push，就push到自己的仓库了
+ 
+ c.当您成功push到自己仓库就会出现下图的提示（在IDEA界面的右下角）
+ 
+
+7. 创建一个Pull Request (PR)
+例：
+ a.当您成功push到自己的仓库当中后，进入自己的仓库主页，会出现下图界面
+ 
+ b.点击Compare & pull request，就会出现以下界面，按照图中操作即可创建pull request
+ 
+
## 解释
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/design-document/01-workflow.md b/i18n/zh/docusaurus-plugin-content-docs/current/design-document/01-workflow.md
index 444c0945..af561263 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/design-document/01-workflow.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/design-document/01-workflow.md
@@ -6,7 +6,7 @@
为了实现高可用和高性能，你可以使用事件驱动架构（EDA）构建微服务应用去处理商店前端，订单管理，支付处理和发货管理。你可以在云上部署整个系统。要处理高并发，你可以利用消息系统缓冲，并扩展多个微服务实例。架构类似于：
-
+
当每个微服务都在自己的事件通道上运行时，EventMesh在执行事件编排方面发挥着至关重要的作用。
@@ -178,13 +178,13 @@ events:
对应的工作流图如下：
-
+
## EventMesh工作流引擎
在下面的体系结构图中, EventMesh目录, EventMesh工作流引擎 和 EventMesh Runtime在三个不同的处理器中运行。
-
+
运行工作流的步骤如下：
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/design-document/02-runtime-protocol.md b/i18n/zh/docusaurus-plugin-content-docs/current/design-document/02-runtime-protocol.md
index d5f15560..a7cdc478 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/design-document/02-runtime-protocol.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/design-document/02-runtime-protocol.md
@@ -2,8 +2,6 @@
#### 1. 协议格式
-
-
**消息组成详解：**
```
@@ -142,15 +140,15 @@ public enum Command {
+ 发送RR消息
-
+
+ 发送异步单播消息
-
+
+ 发送广播消息
-
+
## HTTP协议文档
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/design-document/03-stream.md b/i18n/zh/docusaurus-plugin-content-docs/current/design-document/03-stream.md
index 9f733d82..20e6412f 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/design-document/03-stream.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/design-document/03-stream.md
@@ -34,7 +34,7 @@
## 架构
-
+
## 设计
@@ -80,7 +80,7 @@
Component 接口是主要的入口点，您可以使用 Component 对象作为工厂来创建 EndPoint 对象。
-
+
### EndPoint（端点）
@@ -89,14 +89,14 @@ EndPoint 作为创建消费者、生产者和事件对象的工厂。
- `createConsumer()` — 创建消费者端点，该端点表示路由开始的源端点。
- `createProducer()` — 创建生产者端点，该端点表示路由末端的目标端点。
-
+
#### Producer（生产者）
用户可以创建以下类型的生产者
> 同步生产者：处理线程阻塞，直到生产者完成事件处理。
-
+
未来将会实现的生产者类型：
@@ -107,7 +107,7 @@ EndPoint 作为创建消费者、生产者和事件对象的工厂。
用户可以创建以下类型的消费者
> 事件驱动的消费者：当消息绑定器调用消费者中的方法时，开始处理传入请求。
-
+
未来将会实现的消费者类型：
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/design-document/06-cloudevents.md b/i18n/zh/docusaurus-plugin-content-docs/current/design-document/06-cloudevents.md
index 2d53e607..fb9d1637 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/design-document/06-cloudevents.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/design-document/06-cloudevents.md
@@ -43,7 +43,7 @@ EventMesh 的用户非常渴望能得到对 CloudEvents 的支持。有许多理
### 可插拔协议
-
+
### EventMesh 集成 CloudEvents 进度表
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/design-document/09-event-bridge.md b/i18n/zh/docusaurus-plugin-content-docs/current/design-document/09-event-bridge.md
index b74b78e0..0bacec28 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/design-document/09-event-bridge.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/design-document/09-event-bridge.md
@@ -1,10 +1,10 @@
# Event Bridge
-
+
Event Bridge 可以支持跨mesh集群的消息投递，下面展示这一功能的详细设计与体验步骤
-
+
> 注：在本地体验这一功能时需要启动两台eventmesh实例，同时要修改`eventmesh-runtime`目录下的`eventmesh.properties`文件中的端口配置，避免端口冲突。便于下文描述，event-bridge特性按照上图信息进行表述。
@@ -153,4 +153,4 @@ Event Bridge 可以支持跨mesh集群的消息投递，下面展示这一功能
"TEST-TOPIC-HTTP-ASYNC"
]
}
-```
\ No newline at end of file
+```
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/design-document/11-prometheus.md b/i18n/zh/docusaurus-plugin-content-docs/current/design-document/11-prometheus.md
index 067cd00a..e262c511 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/design-document/11-prometheus.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/design-document/11-prometheus.md
@@ -8,18 +8,10 @@
选择自己电脑对应的版本下载并解压缩
-
-
### 2、在prometheus.yml中添加配置
如果你是Prometheus的新手，可以直接复制eventmesh-runtime/conf/prometheus.yml替换
-例如：这是win-64的下载后的样子：
-
-
-
-替换红框中的文件
-
如果你十分了解Prometheus，可以自行配置，eventmesh默认的导出的端口为19090。
ps：如果需要更换端口的话，请修改eventmesh-runtime/conf/eventmesh.properties中的
@@ -42,5 +34,3 @@ eventMesh.metrics.prometheus.port=19090
### 输入想观察的 Metrics
输入’**eventmesh_**‘ 就会出现相关的指标的提示
-
-
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/design-document/15-https.md b/i18n/zh/docusaurus-plugin-content-docs/current/design-document/14-https.md
similarity index 100%
rename from i18n/zh/docusaurus-plugin-content-docs/current/design-document/15-https.md
rename to i18n/zh/docusaurus-plugin-content-docs/current/design-document/14-https.md
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/design-document/14-webhook.md b/i18n/zh/docusaurus-plugin-content-docs/current/design-document/15-webhook.md
similarity index 96%
rename from i18n/zh/docusaurus-plugin-content-docs/current/design-document/14-webhook.md
rename to i18n/zh/docusaurus-plugin-content-docs/current/design-document/15-webhook.md
index aa4d497f..17a78e75 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/design-document/14-webhook.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/design-document/15-webhook.md
@@ -45,7 +45,7 @@ eventMesh.webHook.producer.connector=standalone
private String manufacturerEventName;
/**
- *
+ *
* http header content type
*/
private String contentType = "application/json";
@@ -251,13 +251,13 @@ contentType： application/json
### github 注册
#### 第一步：进入对应的项目
#### 第二步：点击setting
-
+
#### 第三步：点击Webhooks
-
+
#### 第四步：点击 Add webhook
-
+
#### 第五步: 填写webhook信息
-
+
Payload URL: 服务地址以及pahts。[http or https ]://[域名 or IP 【厂商可以被调用】]:[端口]/webhook/[callbackPath]
Content type：http header content type
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/introduction.md b/i18n/zh/docusaurus-plugin-content-docs/current/introduction.md
index 43c821dd..b0770b93 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/introduction.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/introduction.md
@@ -11,16 +11,6 @@
EventMesh是一个动态的云原生事件驱动架构基础设施，用于分离应用程序和后端中间件层，它支持广泛的用例，包括复杂的混合云、使用了不同技术栈的分布式架构。
-
-
-**EventMesh架构：**
-
-
-
-**EventMesh云原生结构：**
-
-
-
Event Mesh允许将来自一个应用程序的事件动态路由到任何其他应用程序. Event Mesh的一般功能:
* 事件驱动;
@@ -42,8 +32,7 @@ Event Mesh允许将来自一个应用程序的事件动态路由到任何其他
## 贡献
-永远欢迎参与共建, 请参阅[贡献](../../03-new-contributor-guidelines.md)了解详细指南
+永远欢迎参与共建, 请参阅[贡献](contribute/03-new-contributor-guidelines.md)了解详细指南
您可以从发现和解决问题开始～
[GitHub Issues](https://github.com/apache/incubator-eventmesh/issues)
-
diff --git a/static/images/contribute/checkstyle01.png b/static/images/contribute/checkstyle01.png
new file mode 100644
index 00000000..84ceb3fa
Binary files /dev/null and b/static/images/contribute/checkstyle01.png differ
diff --git a/static/images/contribute/checkstyle02.png b/static/images/contribute/checkstyle02.png
new file mode 100644
index 00000000..fb3a2e77
Binary files /dev/null and b/static/images/contribute/checkstyle02.png differ
diff --git a/static/images/contribute/checkstyle03.png b/static/images/contribute/checkstyle03.png
new file mode 100644
index 00000000..e3cd1671
Binary files /dev/null and b/static/images/contribute/checkstyle03.png differ
diff --git a/static/images/contribute/checkstyle04.png b/static/images/contribute/checkstyle04.png
new file mode 100644
index 00000000..87723c97
Binary files /dev/null and b/static/images/contribute/checkstyle04.png differ
diff --git a/static/images/contribute/checkstyle05.png b/static/images/contribute/checkstyle05.png
new file mode 100644
index 00000000..f8c6ec28
Binary files /dev/null and b/static/images/contribute/checkstyle05.png differ
diff --git a/static/images/contribute/checkstyle06.png b/static/images/contribute/checkstyle06.png
new file mode 100644
index 00000000..cbfbf320
Binary files /dev/null and b/static/images/contribute/checkstyle06.png differ
diff --git a/static/images/contribute/zh/contribute01.png b/static/images/contribute/zh/contribute01.png
new file mode 100644
index 00000000..3e26d1c2
Binary files /dev/null and b/static/images/contribute/zh/contribute01.png differ
diff --git a/static/images/contribute/zh/contribute02.png b/static/images/contribute/zh/contribute02.png
new file mode 100644
index 00000000..0fdb57a9
Binary files /dev/null and b/static/images/contribute/zh/contribute02.png differ
diff --git a/static/images/contribute/zh/contribute03.png b/static/images/contribute/zh/contribute03.png
new file mode 100644
index 00000000..25feb794
Binary files /dev/null and b/static/images/contribute/zh/contribute03.png differ
diff --git a/static/images/contribute/zh/contribute04.png b/static/images/contribute/zh/contribute04.png
new file mode 100644
index 00000000..fd7fe759
Binary files /dev/null and b/static/images/contribute/zh/contribute04.png differ
diff --git a/static/images/contribute/zh/contribute05.png b/static/images/contribute/zh/contribute05.png
new file mode 100644
index 00000000..ea3f3784
Binary files /dev/null and b/static/images/contribute/zh/contribute05.png differ
diff --git a/static/images/contribute/zh/contribute06.png b/static/images/contribute/zh/contribute06.png
new file mode 100644
index 00000000..77a57117
Binary files /dev/null and b/static/images/contribute/zh/contribute06.png differ
diff --git a/static/images/contribute/zh/contribute07.png b/static/images/contribute/zh/contribute07.png
new file mode 100644
index 00000000..1fe3218a
Binary files /dev/null and b/static/images/contribute/zh/contribute07.png differ
diff --git a/static/images/contribute/zh/contribute08.png b/static/images/contribute/zh/contribute08.png
new file mode 100644
index 00000000..735e45b7
Binary files /dev/null and b/static/images/contribute/zh/contribute08.png differ
diff --git a/static/images/contribute/zh/contribute09.png b/static/images/contribute/zh/contribute09.png
new file mode 100644
index 00000000..76532380
Binary files /dev/null and b/static/images/contribute/zh/contribute09.png differ
diff --git a/static/images/contribute/zh/contribute10.png b/static/images/contribute/zh/contribute10.png
new file mode 100644
index 00000000..446c788b
Binary files /dev/null and b/static/images/contribute/zh/contribute10.png differ
diff --git a/static/images/contribute/zh/contribute11.png b/static/images/contribute/zh/contribute11.png
new file mode 100644
index 00000000..45677c58
Binary files /dev/null and b/static/images/contribute/zh/contribute11.png differ
diff --git a/static/images/contribute/zh/contribute12.png b/static/images/contribute/zh/contribute12.png
new file mode 100644
index 00000000..dee6656c
Binary files /dev/null and b/static/images/contribute/zh/contribute12.png differ
diff --git a/static/images/contribute/zh/contribute13.png b/static/images/contribute/zh/contribute13.png
new file mode 100644
index 00000000..bacf42e1
Binary files /dev/null and b/static/images/contribute/zh/contribute13.png differ
diff --git a/static/images/contribute/zh/contribute14.png b/static/images/contribute/zh/contribute14.png
new file mode 100644
index 00000000..2abb07c8
Binary files /dev/null and b/static/images/contribute/zh/contribute14.png differ
diff --git a/static/images/contribute/zh/contribute15.png b/static/images/contribute/zh/contribute15.png
new file mode 100644
index 00000000..bb439af5
Binary files /dev/null and b/static/images/contribute/zh/contribute15.png differ
diff --git a/static/images/contribute/zh/contribute16.png b/static/images/contribute/zh/contribute16.png
new file mode 100644
index 00000000..cc9d653e
Binary files /dev/null and b/static/images/contribute/zh/contribute16.png differ
diff --git a/static/images/contribute/zh/contribute17.png b/static/images/contribute/zh/contribute17.png
new file mode 100644
index 00000000..85683c48
Binary files /dev/null and b/static/images/contribute/zh/contribute17.png differ
diff --git a/static/images/dashboard.png b/static/images/dashboard.png
new file mode 100644
index 00000000..7b90d139
Binary files /dev/null and b/static/images/dashboard.png differ
diff --git a/static/images/design-document/event-bridge-detail.png b/static/images/design-document/event-bridge-detail.png
new file mode 100644
index 00000000..95f81524
Binary files /dev/null and b/static/images/design-document/event-bridge-detail.png differ
diff --git a/static/images/design-document/tcp-protocol.png b/static/images/design-document/tcp-protocol.png
new file mode 100644
index 00000000..d3c1249d
Binary files /dev/null and b/static/images/design-document/tcp-protocol.png differ
diff --git a/static/images/design-document/webhook/webhook-github-add.png b/static/images/design-document/webhook/webhook-github-add.png
new file mode 100644
index 00000000..55e19cb6
Binary files /dev/null and b/static/images/design-document/webhook/webhook-github-add.png differ
diff --git a/static/images/design-document/webhook/webhook-github-info.png b/static/images/design-document/webhook/webhook-github-info.png
new file mode 100644
index 00000000..978b64eb
Binary files /dev/null and b/static/images/design-document/webhook/webhook-github-info.png differ
diff --git a/static/images/design-document/webhook/webhook-github-setting.png b/static/images/design-document/webhook/webhook-github-setting.png
new file mode 100644
index 00000000..fa151313
Binary files /dev/null and b/static/images/design-document/webhook/webhook-github-setting.png differ
diff --git a/static/images/design-document/webhook/webhook-github-webhooks.png b/static/images/design-document/webhook/webhook-github-webhooks.png
new file mode 100644
index 00000000..978b64eb
Binary files /dev/null and b/static/images/design-document/webhook/webhook-github-webhooks.png differ
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: commits-help@eventmesh.apache.org