search

apache / eventmesh

EventMesh is a new generation serverless event middleware for building distributed event-driven applications.
https://eventmesh.apache.org/
Apache License 2.0
1.6k stars 637 forks source link

[Doc] Need documentation for connectors #4601

Open pandaapo opened 10 months ago

pandaapo commented 10 months ago

Search before asking

Documentation Related

List of connectors without documentation

Currently, most connectors lack documentation, such as the functions of the current connector, descriptions of configuration items, precautions (if any), relevant official reference links (if any), and other content that needs to be explained in the documentation. This can cause difficulties for users, even directly hindering their use, and also increase the difficulty for other developers to understand or optimize the code.

The author information in the list does not mean that the corresponding document must be written by the author. Anyone, including the author, can write a document for the module you are interested in. If non authors encounter problems while writing documents, they can try contacting the corresponding author or community.

Welcome to select the module or modules that interest you and create the corresponding issue and PR to complete documents.

Note: In the future, community will mainly maintain documents in eventmesh-site. Therefore, if it is convenient for you, please write the new English documents in this directory of eventmesh-site, and Chinese documents in the directory.

目前大部分的Connector缺少文档，比如当前Connector的功能、配置项的说明、需要注意的情况（如果有）、相关官方依据链接（如果有），等等其他需要在文档中说明的内容。这会给用户的使用造成困难，甚至直接阻碍了用户的使用，也提高了其他开发者对代码的理解或者优化难度。 列表中的作者信息不表示必须由作者来写相应的文档，包括作者在内的任何人都可以写您感兴趣的模块的文档。如果非作者写文档时遇到问题，可以尝试联系相应的作者或者社区。 欢迎选择您感兴趣的模块并创建相应的的issue和PR完成文档。 注意：以后社区主要在 eventmesh-site 项目中维护文档，所以如果您方便的话，请将新的英文文档写到eventmesh-site项目的directory目录下，中文文档写在directory目录下。

Are you willing to submit PR?

Code of Conduct

fabian4 commented 10 months ago

@pandaapo Where should we put the doc? In the relevant project path or somewhere else like our offical website doc for better reference.

pandaapo commented 10 months ago

We can temporarily place the documents(README.md in English and README_CN.md in Chinese) in the corresponding connector project path.

In the future, community will mainly maintain documents in eventmesh-site. Therefore, if it is convenient for you, please write the new English documents in this directory of eventmesh-site, and Chinese documents in the directory.

VishalMCF commented 10 months ago

@pandaapo Hi, I would like to give it a try. I will create all the issues and will take up one of them.

pandaapo commented 10 months ago

@pandaapo Hi, I would like to give it a try. I will create all the issues and will take up one of them.

@VishalMCF OK, thank you!

@fabian4 Do you have anything to say? Have you planned to write one or some of these documents?

VishalMCF commented 10 months ago

@pandaapo I see that we have many connectors related to many technologies. Are there any new connectors that are on your roadmap?

pandaapo commented 10 months ago

@pandaapo I see that we have many connectors related to many technologies. Are there any new connectors that are on your roadmap?

@VishalMCF The purpose of this issue is to provide additional documentation for all connectors that have been implemented so far.

When a new connector (https://github.com/apache/eventmesh/tree/master/eventmesh-connectors#connector-status) is developed in the future, if I participate in reviewing, I will suggest that the developer write the documentation in the PR.

If a new connector is missing documentation, I will add the corresponding connector to this issue list.

VishalMCF commented 10 months ago

@pandaapo Okay. that is fine. I just wanted to know if there was something in the development roadmap.

pandaapo commented 10 months ago

@VishalMCF I see that you have checked "Yes I am willing to submit a PR!" in all the [Doc] issues you created. Are you planning to write all these connectors documents that you have checked yourself?

VishalMCF commented 10 months ago

@pandaapo Anyone can take them up. I will work on them one by one based on the difficulty level. If someone is interested they can assign themself. Edit: I unchecked that option so that it does not cause any confusion.

VishalMCF commented 10 months ago

@pandaapo I see that all the connectors have a dependency on the events-open connect-java module. Don't you think there should be documentation for that too for the developers?

pandaapo commented 10 months ago

@pandaapo I see that all the connectors have a dependency on the events-open connect-java module. Don't you think there should be documentation for that too for the developers?

@VishalMCF The original intention of writing these documents I mentioned above is mainly for the convenience of users. eventmesh-openconnect-java module is used internally within eventmesh framework. If that documentation is needed, it should be a development or design document. I am not sure if the community will currently plan for this kind of work.

VishalMCF commented 10 months ago

@pandaapo I think it would be better if an author of the module publishes documentation for the module. Based on that format, I can write the documentation for the other connectors. Meanwhile, I am trying to run EventMesh with storage other than rocketmq. Is it okay?

pandaapo commented 9 months ago

@VishalMCF

@pandaapo I think it would be better if an author of the module publishes documentation for the module. Based on that format?

This PR #4599 that will be merged includes documentation for Lark Connector, which can be used as a reference. If you find new content, it can also be supplemented.

I am trying to run EventMesh with storage other than rocketmq. Is it okay?

It is OK.

VishalMCF commented 9 months ago

Okay. I will look into it. Thanks for the constant guidance @pandaapo :)

fabian4 commented 9 months ago

@fabian4 Do you have anything to say? Have you planned to write one or some of these documents?

@pandaapo I'll write it later. Sorry for the late response.

mxsm commented 9 months ago

@pandaapo Jdbc connector doc will wirte it after the mysql sink finished

pandaapo commented 9 months ago

In the future, community will mainly maintain documents in eventmesh-site. Therefore, if it is convenient for you, please write the new English documents in this directory of eventmesh-site, and Chinese documents in the directory.