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: changed "Kafka" to "AMQP" in docs #3568

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

docs: changed "Kafka" to "AMQP" in docs #3568

wants to merge 4 commits into from
+1 −1

Conversation

HARDY8118
Copy link

@HARDY8118 HARDY8118 commented Jan 12, 2025 •
edited by coderabbitai bot
Loading

Description

  • Changed the text describing the example(s), updated kafka broker to AMQP broker

Related issue(s)
Resolves #3567

Summary by CodeRabbit

  • Documentation
    • Updated security tutorial to replace "Kafka broker" with "RabbitMQ broker"
    • Improved security configuration example with a reusable user-password security scheme

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jan 12, 2025 •
edited
Loading

Walkthrough

The pull request updates the security documentation for AsyncAPI, specifically modifying the description in the getting started tutorial. The changes involve replacing references to "Kafka broker" with "RabbitMQ broker" to accurately reflect the type of message broker being discussed. A new security scheme named user-password has been added to the components.securitySchemes section, demonstrating a more reusable approach to defining security configurations.

Changes

File Change Summary
markdown/docs/tutorials/getting-started/security.md - Replaced "Kafka broker" with "RabbitMQ broker" in text description
- Added user-password security scheme in components.securitySchemes

Assessment against linked issues

Objective Addressed Explanation
Fix broker protocol mismatch [#3567] ✅
Correct text description to match protocol ✅

Poem

🐰 A rabbit's tale of docs so bright,
Where RabbitMQ brokers now shine light,
Security schemes, neat and clean,
No more Kafka where it shouldn't be seen,
Documentation, crisp and right! 🔒

📜 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 20462e6 and a7220a5.

📒 Files selected for processing (1)
  • markdown/docs/tutorials/getting-started/security.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • markdown/docs/tutorials/getting-started/security.md
⏰ Context from checks skipped due to timeout of 180000ms (2)
  • GitHub Check: Test NodeJS PR - windows-latest
  • GitHub Check: Test NodeJS PR - macos-13

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.

github-actions[bot]
github-actions bot reviewed Jan 12, 2025
View reviewed changes
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide 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.

@netlify Netlify
Copy link

netlify bot commented Jan 12, 2025 •
edited
Loading

✅ Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit a7220a5
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/67853b90abcab100083543cc
😎 Deploy Preview https://deploy-preview-3568--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 Jan 12, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (7bc229e) to head (a7220a5).

Additional details and impacted files 
@@            Coverage Diff            @@
##            master     #3568   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           19        19           
  Lines          668       668           
=========================================
  Hits           668       668

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

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Jan 12, 2025 •
edited
Loading

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 39
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

Lighthouse ran on https://deploy-preview-3568--asyncapi-website.netlify.app/

@HARDY8118 HARDY8118 changed the title docs: Changed "Kafka" to "AMQP" in docs docs: changed "Kafka" to "AMQP" in docs Jan 12, 2025
TRohit20
TRohit20 approved these changes Jan 13, 2025
View reviewed changes
Copy link
Collaborator

@TRohit20 TRohit20 left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for noticing the inconsistency but AMQP is a protocol and not a broker. Hence the below suggestion :)

@TRohit20 TRohit20 self-requested a review January 13, 2025 15:12
@HARDY8118
Copy link
Author

Thanks for noticing the inconsistency but AMQP is a protocol and not a broker. Hence the below suggestion :)

Thanks for the feedback, I have replaced AMQP with RabbitMQ.

@userAdityaa
Copy link

Hey @TRohit20 any update on this or should I work on this ?

@HARDY8118
Copy link
Author

Hi @TRohit20
Can you please check the changes and approve if its okay or suggest changes if required.

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

@github-actions github-actions[bot] github-actions[bot] left review comments

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

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

@BhaswatiRoy BhaswatiRoy Awaiting requested review from BhaswatiRoy

@J0SAL J0SAL Awaiting requested review from J0SAL

@VaishnaviNandakumar VaishnaviNandakumar Awaiting requested review from VaishnaviNandakumar

@TRohit20 TRohit20 Awaiting requested review from TRohit20

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 Bug 🐞 report]: Different brokers in Adding Security page
4 participants
@HARDY8118 @asyncapi-bot @userAdityaa @TRohit20