apache / apache/eventmesh

[Doc] Need documentation for connectors

Open
#4,601 17 comments 0 reactions 0 assignees View on GitHub
documentation help wanted
Dominant language
Java
Stars
1.8k
Forks
658
Avg merge
11h 29m
Merged PRs (30d)
52

Description

### Search before asking

- [X] I had searched in the [issues](https://github.com/apache/eventmesh/issues?q=is%3Aissue) and found no similar issues.

### Documentation Related

List of connectors without documentation
- [x] #4658 (author: @yanrongzhen )
- [x] #4608 (author: @xwm1992 )
- [ ] #4606 (author: @mxsm )
- [x] #4604 (author: @epiao55 )
- [ ] #4611 (author: @fabian4 )
- [x] #4609 (author: @fabian4 )
- [ ] eventmesh-connector-openfunction (author: @xwm1992 )
- [ ] eventmesh-connector-pravega (author: @fabian4 )
- [ ] #4615 (author: @willimpo )
- [ ] #4614 (author: @g0715158 )
- [x] #4607 (author: @fabian4 )
- [x] #4683 (author: @fabian4 )
- [ ] eventmesh-connector-rocketmq (author: @xwm1992 )
- [ ] #4605 (author: @TheR1sing3un )
- [x] #4612 (author: @yanrongzhen )
- [ ] #4613 (author: @yanrongzhen )
- [ ] #4651 (author: @wizardzhang )
- [x] #4663 (author: @yanrongzhen )

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](https://github.com/apache/eventmesh-site). Therefore, if it is convenient for you, please write the new English documents in this [directory](https://github.com/apache/eventmesh-site/tree/master/docs/design-document/03-connect) of eventmesh-site, and Chinese documents in the [directory](https://github.com/apache/eventmesh-site/tree/master/i18n/zh/docusaurus-plugin-content-docs/current/design-document/03-connect).

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

### Are you willing to submit PR?

- [ ] Yes I am willing to submit a PR!

### Code of Conduct

- [ ] I agree to follow this project's [Code of Conduct](https://www.apache.org/foundation/policies/conduct) *

Contributor guide

Open the contributing guide

Research direction

Start in the eventmesh-site docs/design-document/03-connect directory, or its Chinese counterpart at i18n/zh/docusaurus-plugin-content-docs/current/design-document/03-connect, and choose one unchecked connector from the list. Review that connector's functions and configuration, then document its usage, precautions, and official reference links where available; done means the selected connector has complete English or Chinese documentation and a PR.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.