apache / apache/eventmesh-site
[Doc] The introductions of EventMesh Connector and EventMesh Storage are incorrect
- Dominant language
- TypeScript
- Stars
- 26
- Forks
- 51
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 2
Description
(Related issue https://github.com/apache/eventmesh/issues/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 ).
Contributor guide
No contributing guide indexed for this repository
Research direction
Open docs/instruction/03-runtime.md and compare its introductions and examples with the current distinction between EventMesh Connector and EventMesh Storage described in the issue. Update the outdated plugin references and change image paths from /images/... to /static/images/.... Done means the document consistently explains how to use Connector and Storage without directing users to the wrong component.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100