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-knative #4611

Open
2 of 3 tasks
VishalMCF opened this issue Dec 5, 2023 · 1 comment
Open
2 of 3 tasks

[Doc] Documentation Needed for eventmesh-connector-knative #4611

VishalMCF opened this issue Dec 5, 2023 · 1 comment
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
@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.

@Pil0tXia Pil0tXia added the help wanted Extra attention is needed label Jan 19, 2024
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

3 participants