Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Documentation Needed for eventmesh-connector-kafka #4604

Closed
3 tasks done
VishalMCF opened this issue Dec 5, 2023 · 3 comments
Closed
3 tasks done

[Doc] Documentation Needed for eventmesh-connector-kafka #4604

VishalMCF opened this issue Dec 5, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@VishalMCF
Copy link
Contributor

VishalMCF commented Dec 5, 2023

Search before asking

  • I had searched in the issues 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

@VishalMCF VishalMCF added the documentation Improvements or additions to documentation label Dec 5, 2023
Copy link
Contributor

github-actions bot commented Dec 5, 2023

Welcome to the Apache EventMesh community!!
We are glad that you are contributing by opening this issue. :D

Please make sure to include all the relevant context.
We will be here shortly.

If you are interested in contributing to our project, please let us know!
You can check out our contributing guide on contributing to EventMesh.

Want to get closer to the community?

WeChat Assistant WeChat Public Account Slack
Join Slack Chat

Mailing Lists:

Name Description Subscribe Unsubscribe Archive
Users User support and questions mailing list Subscribe Unsubscribe Mail Archives
Development Development related discussions Subscribe Unsubscribe Mail Archives
Commits All commits to repositories Subscribe Unsubscribe Mail Archives
Issues Issues or PRs comments and reviews Subscribe Unsubscribe Mail Archives

@pandaapo
Copy link
Member

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.

@Ish1yu
Copy link
Contributor

Ish1yu commented Mar 13, 2024

its closed by apache/eventmesh-site#204

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants