This is an automated email from the ASF dual-hosted git repository. xiaoyang pushed a commit to branch fix-document in repository https://gitbox.apache.org/repos/asf/incubator-eventmesh.git
commit 0d48ea1d9337082ed036ed273042b11cac6b9a4b Author: Xiaoyang Liu <[email protected]> AuthorDate: Tue Jan 31 19:37:44 2023 -0800 fix: update format of EventMesh documentation Signed-off-by: Xiaoyang Liu <[email protected]> --- docs/en/design-document/01-workflow.md | 6 +- docs/en/design-document/02-runtime-protocol.md | 6 +- docs/en/design-document/03-stream.md | 10 +- docs/en/design-document/04-schema-registry.md | 6 +- docs/en/design-document/06-cloudevents.md | 2 +- docs/en/design-document/09-event-bridge.md | 6 +- docs/en/design-document/14-webhook.md | 14 +- docs/en/instruction/01-store-with-docker.md | 8 +- docs/en/instruction/01-store.md | 14 +- docs/en/instruction/02-runtime-with-docker.md | 5 +- docs/en/instruction/02-runtime.md | 10 +- docs/en/instruction/03-demo.md | 2 +- docs/en/sdk-java/{intro.md => 01-intro.md} | 0 docs/en/upgrade-guide/01-upgrade-guide.md | 15 +++ docs/en/upgrade-guide/_category_.json | 5 + .../zh/contribute/03-new-contributor-guidelines.md | 144 ++++++++++----------- docs/zh/contribute/_category_.json | 2 +- .../01-workflow.md | 6 +- .../02-runtime-protocol.md | 8 +- .../03-stream.md | 10 +- .../05-metrics-export.md | 0 .../06-cloudevents.md | 2 +- .../{desing-document => design-document}/08-spi.md | 0 .../09-event-bridge.md | 6 +- .../10-knative-connector.md | 0 .../11-prometheus.md | 10 -- .../12-zipkin.md | 0 .../13-jaeger.md | 0 .../https.md => design-document/14-https.md} | 0 .../webhook.md => design-document/15-webhook.md} | 10 +- docs/zh/design-document/_category_.json | 4 + docs/zh/desing-document/_category_.json | 4 - docs/zh/instruction/00-eclipse.md | 11 +- docs/zh/instruction/_category_.json | 2 +- docs/zh/introduction.md | 14 +- docs/zh/sdk-java/01-intro.md | 4 +- 36 files changed, 169 insertions(+), 177 deletions(-) diff --git a/docs/en/design-document/01-workflow.md b/docs/en/design-document/01-workflow.md index fecae1ee6..435891784 100644 --- a/docs/en/design-document/01-workflow.md +++ b/docs/en/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/en/design-document/02-runtime-protocol.md b/docs/en/design-document/02-runtime-protocol.md index b992bf896..0b213b7e1 100644 --- a/docs/en/design-document/02-runtime-protocol.md +++ b/docs/en/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/en/design-document/03-stream.md b/docs/en/design-document/03-stream.md index d379ccddd..7f2534a5d 100644 --- a/docs/en/design-document/03-stream.md +++ b/docs/en/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/en/design-document/04-schema-registry.md b/docs/en/design-document/04-schema-registry.md index 5c0b65f98..7c5d22826 100644 --- a/docs/en/design-document/04-schema-registry.md +++ b/docs/en/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/en/design-document/06-cloudevents.md b/docs/en/design-document/06-cloudevents.md index 20a99d182..bff91b457 100644 --- a/docs/en/design-document/06-cloudevents.md +++ b/docs/en/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/en/design-document/09-event-bridge.md b/docs/en/design-document/09-event-bridge.md index b74b78e01..0bacec280 100644 --- a/docs/en/design-document/09-event-bridge.md +++ b/docs/en/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/en/design-document/14-webhook.md b/docs/en/design-document/14-webhook.md index 13ec4de06..02f4bcf1e 100644 --- a/docs/en/design-document/14-webhook.md +++ b/docs/en/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/en/instruction/01-store-with-docker.md b/docs/en/instruction/01-store-with-docker.md index 8c102b249..7c03f1c68 100644 --- a/docs/en/instruction/01-store-with-docker.md +++ b/docs/en/instruction/01-store-with-docker.md @@ -10,7 +10,6 @@ Gradle 7.0+, we recommend 7.0.* 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. ``` - ## Download Download the Binary code (recommended: 4.9.*) from [RocketMQ Official](https://rocketmq.apache.org/dowloading/releases/). Here we take 4.9.2 as an example. @@ -20,7 +19,6 @@ unzip rocketmq-all-4.9.2-bin-release.zip cd rocketmq-4.9.2/ ``` - ## Deploy - #### Start Name Server @@ -39,9 +37,8 @@ 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) - - ## Deploy + Pull RocketMQ image from Docker Hub： ```shell @@ -63,9 +60,8 @@ sudo docker run -d -p 10911:10911 -p 10909:10909 -v `pwd`/data/broker/logs:/root 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**。 - 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) - ## Reference + For more details about RocketMQ，please refer to <https://rocketmq.apache.org/docs/quick-start/> diff --git a/docs/en/instruction/01-store.md b/docs/en/instruction/01-store.md index ab281c7ca..f409d6522 100644 --- a/docs/en/instruction/01-store.md +++ b/docs/en/instruction/01-store.md @@ -2,7 +2,7 @@ ## Dependencies -``` +```text 64-bit OS，we recommend Linux/Unix； 64-bit JDK 1.8+; Gradle 7.0+, we recommend 7.0.* @@ -10,7 +10,6 @@ Gradle 7.0+, we recommend 7.0.* 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. ``` - ## Download Download the Binary code (recommended: 4.9.*) from [RocketMQ Official](https://rocketmq.apache.org/dowloading/releases/). Here we take 4.9.2 as an example. @@ -20,25 +19,24 @@ unzip rocketmq-all-4.9.2-bin-release.zip cd rocketmq-4.9.2/ ``` - ## Deploy -- #### Start Name Server +### Start Name Server -``` +```console nohup sh bin/mqnamesrv & tail -f ~/logs/rocketmqlogs/namesrv.log ``` -- #### Start Broker +### 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 + For more details about RocketMQ, please refer to <https://rocketmq.apache.org/docs/quick-start/> diff --git a/docs/en/instruction/02-runtime-with-docker.md b/docs/en/instruction/02-runtime-with-docker.md index 7da3e2a43..31e5c29c9 100644 --- a/docs/en/instruction/02-runtime-with-docker.md +++ b/docs/en/instruction/02-runtime-with-docker.md @@ -2,8 +2,8 @@ The documentation introduces the steps to install the latest release of EventMesh Runtime with Docker and connect to Apache RocketMQ. It's recommended to use a Linux-based system with [Docker Engine](https://docs.docker.com/engine/install/). Please follow the [Docker tutorial](https://docs.docker.com/get-started/) to get familiar with the basic concepts (registry, volume, etc.) and commands of Docker. - ## Dependencies + ``` 64-bit OS，we recommend Linux/Unix； 64-bit JDK 1.8+; @@ -17,7 +17,7 @@ If you choose standalone mode, you could skip this file and go to the next step: Download the pre-built image of [`eventmesh`](https://hub.docker.com/r/eventmesh/eventmesh) from Docker Hub with `docker pull`: ```console -$ sudo docker pull eventmesh/eventmesh:v1.4.0 +sudo docker pull eventmesh/eventmesh:v1.4.0 ``` To verify that the `eventmesh/eventmesh` image is successfully installed, list the downloaded images with `docker images`: @@ -104,4 +104,3 @@ sudo docker stop [container id or name] sudo docker rm -f [container id or name] ``` - diff --git a/docs/en/instruction/02-runtime.md b/docs/en/instruction/02-runtime.md index 66bfca7f6..3f398d8af 100644 --- a/docs/en/instruction/02-runtime.md +++ b/docs/en/instruction/02-runtime.md @@ -1,11 +1,10 @@ # EventMesh Runtime -EventMesh Runtime is the core component of Apache EventMesh (Incubating). It is the middleware that transmits events between producers and consumers. The documentation introduces the step to install and start the latest release of EventMesh Runtime in the local or test environment. The EventMesh Runtime requires a Linux-based system with JDK (Java Development Kit) 8+. +EventMesh Runtime is the core component of Apache EventMesh (Incubating). It is the middleware that transmits events between producers and consumers. The documentation introduces the step to install and start the latest release of EventMesh Runtime in the local or test environment. The EventMesh Runtime requires a Linux-based system with JDK (Java Development Kit) 8+. Here, we take JDK 8 as an example. JDK 8 could be installed with the system package manager or the [openjdk:8-jdk](https://hub.docker.com/_/openjdk) Docker image. - -## 1 Run on your local machine +## 1 Run on your local machine ### 1.1 Dependencies @@ -70,8 +69,8 @@ dependencies { gradle installPlugin ``` - ## 2 Remote deployment + ### 2.1 Dependencies ``` @@ -83,6 +82,7 @@ If you choose standalone mode, you could skip this file and go to the next step: ``` ### 2.2 Download + Download and extract the executable binaries of the latest release from [EventMesh download](https://eventmesh.apache.org/download). ```console @@ -92,6 +92,7 @@ tar -xvzf apache-eventmesh-1.5.0-incubating-bin.tar.gz ``` ### 2.3 Deploy + Edit the `eventmesh.properties` to change the configuration (e.g. TCP port, client blacklist) of EventMesh Runtime. The executable binaries contain all plugins in the bundle, thus there's no need to build them from source code. ```console @@ -104,4 +105,3 @@ Execute the `start.sh` script to start the EventMesh Runtime server. ```console bash bin/start.sh ``` - diff --git a/docs/en/instruction/03-demo.md b/docs/en/instruction/03-demo.md index 0b99d47b7..6bd8ade6b 100644 --- a/docs/en/instruction/03-demo.md +++ b/docs/en/instruction/03-demo.md @@ -63,7 +63,7 @@ More information about EventMesh-HTTP, please refer to [EventMesh HTTP](/docs/en ## 3 GRPC DEMO -### 3.1 ASYNC PUBLISH & WEBHOOK SUBSCRIBE </h4> +### 3.1 ASYNC PUBLISH & WEBHOOK SUBSCRIBE - Start publisher to publish message (we have created the topic TEST-TOPIC-GRPC-ASYNC by default, you can also create other topic to test) diff --git a/docs/en/sdk-java/intro.md b/docs/en/sdk-java/01-intro.md similarity index 100% rename from docs/en/sdk-java/intro.md rename to docs/en/sdk-java/01-intro.md diff --git a/docs/en/upgrade-guide/01-upgrade-guide.md b/docs/en/upgrade-guide/01-upgrade-guide.md new file mode 100644 index 000000000..e300cdf57 --- /dev/null +++ b/docs/en/upgrade-guide/01-upgrade-guide.md @@ -0,0 +1,15 @@ +# EventMesh Upgrade Guide + +> This article briefly introduces the precautions for upgrading EventMesh from version 1.2.0 to the latest version. + +## 1. Precautions + +**If you are using EventMesh for the first time, you can ignore this chapter.** + +## 2. Service upgrade installation + +The upgrade and startup of the EventMesh runtime module can be done in accordance with the [deployment guide](https://eventmesh.apache.org/docs/instruction/runtime). + +For differences and changes between versions, please refer to the [release notes](https://eventmesh.apache.org/events/release-notes) of different versions. Compatibility between versions can be achieved. + +If you need to use the latest features, follow the release note to upgrade to the corresponding version That’s it, and different plug-in module components can be packaged and configured separately. You can refer to the corresponding [feature design documents and guidelines](https://eventmesh.apache.org/docs/design-document/) diff --git a/docs/en/upgrade-guide/_category_.json b/docs/en/upgrade-guide/_category_.json new file mode 100644 index 000000000..af764643e --- /dev/null +++ b/docs/en/upgrade-guide/_category_.json @@ -0,0 +1,5 @@ +{ + "position": 7, + "label": "Upgrade Guide", + "collapsed": false +} diff --git a/docs/zh/contribute/03-new-contributor-guidelines.md b/docs/zh/contribute/03-new-contributor-guidelines.md index 5a8e42995..0564a1321 100644 --- a/docs/zh/contribute/03-new-contributor-guidelines.md +++ b/docs/zh/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/docs/zh/contribute/_category_.json b/docs/zh/contribute/_category_.json index 56d36f918..c966f6a3a 100644 --- a/docs/zh/contribute/_category_.json +++ b/docs/zh/contribute/_category_.json @@ -1,5 +1,5 @@ { "position": 5, - "label": "Contribute", + "label": "贡献指南", "collapsed": false } diff --git a/docs/zh/desing-document/01-workflow.md b/docs/zh/design-document/01-workflow.md similarity index 97% rename from docs/zh/desing-document/01-workflow.md rename to docs/zh/design-document/01-workflow.md index 444c09454..af5612633 100644 --- a/docs/zh/desing-document/01-workflow.md +++ b/docs/zh/design-document/01-workflow.md @@ -6,7 +6,7 @@ 为了实现高可用和高性能，你可以使用事件驱动架构（EDA）构建微服务应用去处理商店前端，订单管理，支付处理和发货管理。你可以在云上部署整个系统。要处理高并发，你可以利用消息系统缓冲，并扩展多个微服务实例。架构类似于： - + 当每个微服务都在自己的事件通道上运行时，EventMesh在执行事件编排方面发挥着至关重要的作用。 @@ -178,13 +178,13 @@ events: 对应的工作流图如下： - + ## EventMesh工作流引擎 在下面的体系结构图中, EventMesh目录, EventMesh工作流引擎 和 EventMesh Runtime在三个不同的处理器中运行。 - + 运行工作流的步骤如下： diff --git a/docs/zh/desing-document/02-runtime-protocol.md b/docs/zh/design-document/02-runtime-protocol.md similarity index 98% rename from docs/zh/desing-document/02-runtime-protocol.md rename to docs/zh/design-document/02-runtime-protocol.md index d5f155602..a7cdc4786 100644 --- a/docs/zh/desing-document/02-runtime-protocol.md +++ b/docs/zh/design-document/02-runtime-protocol.md @@ -2,8 +2,6 @@ #### 1. 协议格式 - - **消息组成详解：** ``` @@ -142,15 +140,15 @@ public enum Command { + 发送RR消息 - + + 发送异步单播消息 - + + 发送广播消息 - + ## HTTP协议文档 diff --git a/docs/zh/desing-document/03-stream.md b/docs/zh/design-document/03-stream.md similarity index 90% rename from docs/zh/desing-document/03-stream.md rename to docs/zh/design-document/03-stream.md index 9f733d82b..20e6412f2 100644 --- a/docs/zh/desing-document/03-stream.md +++ b/docs/zh/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/docs/zh/desing-document/05-metrics-export.md b/docs/zh/design-document/05-metrics-export.md similarity index 100% rename from docs/zh/desing-document/05-metrics-export.md rename to docs/zh/design-document/05-metrics-export.md diff --git a/docs/zh/desing-document/06-cloudevents.md b/docs/zh/design-document/06-cloudevents.md similarity index 98% rename from docs/zh/desing-document/06-cloudevents.md rename to docs/zh/design-document/06-cloudevents.md index 2d53e6079..fb9d16379 100644 --- a/docs/zh/desing-document/06-cloudevents.md +++ b/docs/zh/design-document/06-cloudevents.md @@ -43,7 +43,7 @@ EventMesh 的用户非常渴望能得到对 CloudEvents 的支持。有许多理 ### 可插拔协议 - + ### EventMesh 集成 CloudEvents 进度表 diff --git a/docs/zh/desing-document/08-spi.md b/docs/zh/design-document/08-spi.md similarity index 100% rename from docs/zh/desing-document/08-spi.md rename to docs/zh/design-document/08-spi.md diff --git a/docs/zh/desing-document/09-event-bridge.md b/docs/zh/design-document/09-event-bridge.md similarity index 97% rename from docs/zh/desing-document/09-event-bridge.md rename to docs/zh/design-document/09-event-bridge.md index b74b78e01..0bacec280 100644 --- a/docs/zh/desing-document/09-event-bridge.md +++ b/docs/zh/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/zh/desing-document/10-knative-connector.md b/docs/zh/design-document/10-knative-connector.md similarity index 100% rename from docs/zh/desing-document/10-knative-connector.md rename to docs/zh/design-document/10-knative-connector.md diff --git a/docs/zh/desing-document/11-prometheus.md b/docs/zh/design-document/11-prometheus.md similarity index 80% rename from docs/zh/desing-document/11-prometheus.md rename to docs/zh/design-document/11-prometheus.md index 067cd00ab..e262c511f 100644 --- a/docs/zh/desing-document/11-prometheus.md +++ b/docs/zh/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/docs/zh/desing-document/12-zipkin.md b/docs/zh/design-document/12-zipkin.md similarity index 100% rename from docs/zh/desing-document/12-zipkin.md rename to docs/zh/design-document/12-zipkin.md diff --git a/docs/zh/desing-document/13-jaeger.md b/docs/zh/design-document/13-jaeger.md similarity index 100% rename from docs/zh/desing-document/13-jaeger.md rename to docs/zh/design-document/13-jaeger.md diff --git a/docs/zh/desing-document/https.md b/docs/zh/design-document/14-https.md similarity index 100% rename from docs/zh/desing-document/https.md rename to docs/zh/design-document/14-https.md diff --git a/docs/zh/desing-document/webhook.md b/docs/zh/design-document/15-webhook.md similarity index 96% rename from docs/zh/desing-document/webhook.md rename to docs/zh/design-document/15-webhook.md index aa4d497f5..17a78e75d 100644 --- a/docs/zh/desing-document/webhook.md +++ b/docs/zh/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/docs/zh/design-document/_category_.json b/docs/zh/design-document/_category_.json new file mode 100644 index 000000000..dd1d53008 --- /dev/null +++ b/docs/zh/design-document/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "开发文档", + "collapsed": false +} diff --git a/docs/zh/desing-document/_category_.json b/docs/zh/desing-document/_category_.json deleted file mode 100644 index 95b7eed06..000000000 --- a/docs/zh/desing-document/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Documentation", - "collapsed": false -} diff --git a/docs/zh/instruction/00-eclipse.md b/docs/zh/instruction/00-eclipse.md index 27ded4952..c72c0bc6b 100644 --- a/docs/zh/instruction/00-eclipse.md +++ b/docs/zh/instruction/00-eclipse.md @@ -9,25 +9,28 @@ eclipse 已安装gradle插件或者eclipse自带gradle插件 ``` ### 下载源码 -git init -git clone https://github.com/apache/incubator-eventmesh.git +git init + +git clone <https://github.com/apache/incubator-eventmesh.git> ### 项目编译eclipse环境 打开命令行终端，运行gradlew cleanEclipse eclipse ### 配置修改 + 修改工程名称和settings.gradle 配置文件参数rootProject.name 参数一致 ### 修改eclipse.init配置文件,配置lombok以1.18.8版本为例 + -javaagent:lombok-1.18.8.jar -XBootclasspath/a:lombok-1.18.8.jar ### 202106版本eclipse,eclipse.init增加配置参数 ---illegal-access=permit +--illegal-access=permit ### 导入gradle -打开eclipse,导入gradle项目到IDE里 +打开eclipse,导入gradle项目到IDE里 diff --git a/docs/zh/instruction/_category_.json b/docs/zh/instruction/_category_.json index 06fd721fb..838cabfe1 100644 --- a/docs/zh/instruction/_category_.json +++ b/docs/zh/instruction/_category_.json @@ -1,4 +1,4 @@ { - "label": "Instructions", + "label": "使用教程", "collapsed": false } diff --git a/docs/zh/introduction.md b/docs/zh/introduction.md index 43c821dd6..ca2472f75 100644 --- a/docs/zh/introduction.md +++ b/docs/zh/introduction.md @@ -11,16 +11,6 @@ EventMesh是一个动态的云原生事件驱动架构基础设施，用于分离应用程序和后端中间件层，它支持广泛的用例，包括复杂的混合云、使用了不同技术栈的分布式架构。 - - -**EventMesh架构：** - - - -**EventMesh云原生结构：** - - - Event Mesh允许将来自一个应用程序的事件动态路由到任何其他应用程序. Event Mesh的一般功能: * 事件驱动; @@ -33,7 +23,6 @@ Event Mesh允许将来自一个应用程序的事件动态路由到任何其他 * eventmesh-runtime：一种中间件，用于在事件生产者和消费者之间传输事件，支持云原生应用程序和微服务 * eventmesh-sdk-java：当前支持HTTP、HHTTP、TCP和 [gRPC](https://grpc.io) 协议 - ## 快速开始 1. 构建并部署 event-store(RocketMQ), 请参见[说明](instruction/01-store.md) @@ -42,8 +31,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/docs/zh/sdk-java/01-intro.md b/docs/zh/sdk-java/01-intro.md index cb4b87640..c49acc230 100644 --- a/docs/zh/sdk-java/01-intro.md +++ b/docs/zh/sdk-java/01-intro.md @@ -1,4 +1,4 @@ -# 安装 +# 安装 SDK [](https://maven-badges.herokuapp.com/maven-central/org.apache.eventmesh/eventmesh-sdk-java) @@ -26,4 +26,4 @@ dependencies { <version>1.4.0</version> </dependency> </dependencies> -``` \ No newline at end of file +``` --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
