[ISSUE #159] [Doc] The introductions of EventMesh Connector and EventMesh Storage are incorrect#232
Conversation
Ensured image source was corrected. Also switched Event Store to EventMesh Storage (which I believe is what was requested). If there's anything else that needs correcting or I understood the instructions wrong, do let me know, and I'll be glad to fix it.
Pil0tXia
added
the
ready for review
| EventMesh Runtime is a stateful Mesh node in the EventMesh cluster, responsible for event transmission between Source Connectors and Sink Connectors. It uses EventMesh Storage as a storage queue for events. | ||
|
|
||
|  |
There was a problem hiding this comment.
The term "Event Store" has been uniformly used in the Eventmesh-site documentation and architecture diagrams, which you can discover by reading the git history.
The main purpose of the issue is to correct the deployment and use of the connector and storage-plugin. You can try deploying a pair of connectors yourself and fix any outdated or incorrect parts in the documentation.
There was a problem hiding this comment.
Updated all references from "EventMesh Connector" to
"EventMesh Storage""Event Store" where applicable.Checked the image path to make sure it started with /static/images/ so images are correctly displayed.
Revised configuration instructions to specify eventMesh.storage.plugin.type=rocketmq instead of eventMesh.connector.plugin.type.
I haven't seen any modifications regarding these points. Could you please check if they have been pushed onto git? Thank you.
2 participants
Fixes #159
Motivation
Explain the content here.
The content of the EventMesh Runtime documentation was outdated and contained incorrect references to the EventMesh Connector. The documentation needed updates to ensure accurate instructions for configuring EventMesh Storage, as well as correcting/checking image paths and terminology.
Explain why you want to make the changes and what problem you're trying to solve.
The changes were made to address user confusion regarding the correct setup and usage of EventMesh Storage and Connectors, as highlighted in issues #159 and #4680. This ensures users can correctly configure and deploy EventMesh with RocketMQ as the storage layer.
Modifications
Describe the modifications you've done.
Updated all references from "EventMesh Connector" to "EventMesh Storage" where applicable.
Checked the image path to make sure it started with /static/images/ so images are correctly displayed.
Revised configuration instructions to specify eventMesh.storage.plugin.type=rocketmq instead of eventMesh.connector.plugin.type.
Added a note at the bottom to clarify the distinction between EventMesh Connectors and EventMesh Storage, including their deployment and configuration.
Do let me know if there's anything that needs fixing or if I understood the instructions wrong. Thanks!
Documentation