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

[📑 Docs]: Alignment between Producers/Consumers and Operations #3450

Open
1 task done
richardszalay opened this issue Dec 5, 2024 · 3 comments
Open
1 task done
Assignees

Comments

@richardszalay
Copy link

What Dev Docs changes are you proposing?

I think it would be worthwhile adding information to the "Adding operations" page that explains how they link to the high level concepts of Consumers and Producers.

As it stands, there's a real disconnect between 'operations' and the high level "Concepts". Operations appear to be the document implementation of both Consumers and Producers, but not only are these concepts not referenced on this page but the language used by operation.action doesn't match those concepts, instead using "receive" and "send".

Code of Conduct

  • I agree to follow this project's Code of Conduct
Copy link

github-actions bot commented Dec 5, 2024

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@kartik-212004
Copy link

/assign

@TRohit20
Copy link
Collaborator

I see @kartik-212004 is willing to take on the task and see it through, I am assigning the document issue to him.

Kartik, please open a PR referring to this issue when ready :) Thank you so much!

@TRohit20 TRohit20 assigned TRohit20 and kartik-212004 and unassigned TRohit20 Dec 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants