apache / apache/eventmesh

[Doc] Documentation Needed for eventmesh-connector-s3

Open
#4,605 1 comment 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

Currently, most connectors lack documentation. The following details must be added to provide better clarity to the developers:- 1. functions of the current connector
2. descriptions of configuration items
3. precautions (if any),
4. relevant official reference links (if any),
5. Other specific content that needs to be explained in the documentation.
Having these details can increase the clarity for the users who are using the product and can also help in onboarding the new developers easily

### Are you willing to submit PR?

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

### Code of Conduct

- [X] 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

Locate the eventmesh-connector-s3 implementation and its configuration definitions first, since no specific files or tests are named. Document the connector's functions, configuration items, precautions, and relevant official references; done means these details are available clearly for users and new developers.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, java
Domain
cloud, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.