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.

Sign up for GitHub

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

Jump to bottom

docs: update docs to explain relationship between operations, Consumers, and Producers #3715

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: update docs to explain relationship between operations, Consumers, and Producers #3715

wants to merge 1 commit into from
+13 −1

Conversation

Recxsmacx
Copy link

@Recxsmacx Recxsmacx commented Feb 19, 2025 •
edited by coderabbitai bot
Loading

Fixes #3450

Add explanation of the relationship between operations, Consumers, and Producers to the 'Adding operations' page.

  • Update markdown/docs/concepts/asyncapi-document/adding-operations.md to include a section explaining the relationship between operations, Consumers, and Producers.
  • Update the language in operation.action to reference "Consumers" and "Producers" alongside "receive" and "send".
  • Add references to the 'Adding operations' page in markdown/docs/concepts/consumer.md and markdown/docs/concepts/producer.md.

Summary by CodeRabbit

  • Documentation
    • Added a new section that explains how operations relate to message sending and receiving roles.
    • Updated examples to clearly denote the consumer role.
    • Enhanced related guides with additional references for further context.

@Recxsmacx
Update docs to explain relationship between operations, Consumers, an…
7bbb6e9 
…d Producers

Fixes asyncapi#3450

Add explanation of the relationship between operations, Consumers, and Producers to the 'Adding operations' page.

* Update `markdown/docs/concepts/asyncapi-document/adding-operations.md` to include a section explaining the relationship between operations, Consumers, and Producers.
* Update the language in `operation.action` to reference "Consumers" and "Producers" alongside "receive" and "send".
* Add references to the 'Adding operations' page in `markdown/docs/concepts/consumer.md` and `markdown/docs/concepts/producer.md`.
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 19, 2025 •
edited
Loading

Walkthrough

The changes update the AsyncAPI documentation by adding a new section titled "Relationship between Operations, Consumers, and Producers" to the operations guide. This section clarifies that an operation with action: send is a Producer and one with action: receive is a Consumer, with the latter example now explicitly labeled as "(Consumer)". Additionally, reference lines have been appended to both the consumer and producer documents to guide readers to the new section.

Changes

File(s) Change Summary
markdown/docs/concepts/.../adding-operations.md Added a new section "Relationship between Operations, Consumers, and Producers" and updated an operation example to explicitly label a consumer.
markdown/docs/concepts/consumer.md, markdown/docs/concepts/producer.md Appended reference lines directing readers to additional details on operation roles and the new section.

Suggested labels

autoapproved, autoupdate

Suggested reviewers

  • quetzalliwrites
  • VaishnaviNandakumar
  • Aahil13
  • asyncapi-bot-eve
  • TRohit20

Poem

I'm just a rabbit, hopping with glee,
Documentation now clear as can be.
Operations and roles in a neat new light,
Sending and receiving, all set just right!
With hops and joy, I celebrate the update! 🐇✨

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2457f7c and 7bbb6e9.

📒 Files selected for processing (3)
  • markdown/docs/concepts/asyncapi-document/adding-operations.md (2 hunks)
  • markdown/docs/concepts/consumer.md (1 hunks)
  • markdown/docs/concepts/producer.md (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • markdown/docs/concepts/consumer.md
  • markdown/docs/concepts/producer.md
⏰ Context from checks skipped due to timeout of 180000ms (5)
  • GitHub Check: Redirect rules - asyncapi-website
  • GitHub Check: Header rules - asyncapi-website
  • GitHub Check: Pages changed - asyncapi-website
  • GitHub Check: Test NodeJS PR - macos-13
  • GitHub Check: Lighthouse CI
🔇 Additional comments (2)
markdown/docs/concepts/asyncapi-document/adding-operations.md (2)

44-44: Clarify the Consumer Notation in the Operation Example.
The updated line correctly annotates the “receive” action with “(Consumer)”, which enhances clarity by explicitly indicating the role of this operation. Please ensure that the same notation is used consistently across similar examples elsewhere in the documentation.

56-62: Enhance Documentation Clarity with the New Section.
The newly added "Relationship between Operations, Consumers, and Producers" section is well written and effectively explains the distinction between Producers and Consumers. The bullet points clearly outline that an operation with an action of send is a Producer, while one with an action of receive is a Consumer. This addition aligns well with the objective to improve users’ understanding of the AsyncAPI framework.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@netlify Netlify
Copy link

netlify bot commented Feb 19, 2025 •
edited
Loading

✅ Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 7bbb6e9
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/67b61ee1c2034a000811624e
😎 Deploy Preview https://deploy-preview-3715--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@codecov Codecov
Copy link

codecov bot commented Feb 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (2457f7c) to head (7bbb6e9).

Additional details and impacted files 
@@            Coverage Diff            @@
##            master     #3715   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           20        20           
  Lines          732       732           
=========================================
  Hits           732       732

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Recxsmacx Recxsmacx changed the title Update docs to explain relationship between operations, Consumers, and Producers docs: Update docs to explain relationship between operations, Consumers, and Producers Feb 19, 2025
@Recxsmacx Recxsmacx changed the title docs: Update docs to explain relationship between operations, Consumers, and Producers docs: update docs to explain relationship between operations, Consumers, and Producers Feb 19, 2025
@TRohit20
Copy link
Collaborator

Can any of the SME double check the technical content before I go for final review and suggest modifications or merge please?

Cc @derberg @fmvilas

@Recxsmacx
Copy link
Author

@VaishnaviNandakumar please review this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@quetzalliwrites quetzalliwrites Awaiting requested review from quetzalliwrites quetzalliwrites is a code owner

@TRohit20 TRohit20 Awaiting requested review from TRohit20 TRohit20 is a code owner

@asyncapi-bot-eve asyncapi-bot-eve Awaiting requested review from asyncapi-bot-eve asyncapi-bot-eve is a code owner

@Aahil13 Aahil13 Awaiting requested review from Aahil13

@VaishnaviNandakumar VaishnaviNandakumar Awaiting requested review from VaishnaviNandakumar

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[📑 Docs]: Alignment between Producers/Consumers and Operations
2 participants
@Recxsmacx @TRohit20