[Doc] Documentation Needed for eventmesh-connector-prometheus
- 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
Research direction
Start by locating the eventmesh-connector-prometheus implementation and its configuration entry points. Review the connector's functions and configuration, then document their usage, any precautions, and relevant official Prometheus references; done means developers can understand and use the connector from the documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, prometheus
- Domain
- documentation, observability
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100