Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] The introductions of EventMesh Connector and EventMesh Storage are incorrect #159

Open
pandaapo opened this issue Dec 19, 2023 · 2 comments · May be fixed by #232
Open

[Doc] The introductions of EventMesh Connector and EventMesh Storage are incorrect #159

pandaapo opened this issue Dec 19, 2023 · 2 comments · May be fixed by #232

Comments

@pandaapo
Copy link
Member

pandaapo commented Dec 19, 2023

(Related issue apache/eventmesh#4680. CC @VishalMCF.)

https://github.com/apache/eventmesh-site/blob/master/docs/instruction/03-runtime.md

Current EventMesh Connector is different from the initial EventMesh Connector, and it is a standalone service now. The initial EventMesh Connector was later changed to EventMesh Storage, but the relevant instructions in the documentation were not changed, resulting in users not knowing how to use Storage and Connector, and even attempting to use Storage or Connector in the wrong way.
For example:

The content of the file is the mapping from the plugin instance name to the plugin instance, see eventmesh-connector-rocketmq plugin module for details.

implementation project(":eventmesh-connectors:eventmesh-connector-rocketmq")

#connector plugin
eventMesh.connector.plugin.type=rocketmq

// Example: Load the RocketMQ plugin
implementation project(":eventmesh-connectors:eventmesh-connector-rocketmq")

Now eventmesh-connector-rocketmq as Connector, it does not run as a plugin, here they should be eventmesh-storage-rocketmq.

Additionally, all of the image paths in this document are incorrect. They should be /static/images/... instead of /images/... (Similar issue: #142 ).

@pandaapo pandaapo changed the title The introductions of EventMesh Connector and EventMesh Storage module are incorrect The introductions of EventMesh Connector and EventMesh Storage are incorrect Dec 19, 2023
@pandaapo pandaapo changed the title The introductions of EventMesh Connector and EventMesh Storage are incorrect [Doc] The introductions of EventMesh Connector and EventMesh Storage are incorrect Dec 20, 2023
@Whitegabriella789
Copy link

May I help with this issue? I am a bit new to GitHub but have taken some courses on it if that's ok. However, I'm not new to writing up documentation.

@VishalMCF
Copy link

VishalMCF commented Jul 3, 2024 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants