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

chore(blog): added new websocket article #3394

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from
Draft

chore(blog): added new websocket article #3394

wants to merge 5 commits into from

Conversation

AceTheCreator
Copy link
Member

A new websocket article using the latest AsyncAPI Spec version.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Nov 14, 2024

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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 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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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 Nov 14, 2024 •
edited
Loading

✅ Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 391a97a
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/673f680a22d4f20008a9fd80
😎 Deploy Preview https://deploy-preview-3394--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.

derberg
derberg reviewed Dec 9, 2024
View reviewed changes
markdown/blog/asyncapi-and-websocket.md
- **SecuritySchemes:** An object that holds reusable security scheme objects
- **Schemas:** and object to hold reusable schema object.

Now, because we want our `#chat` channel to not look overwhelming and difficult to read, we are going to create our message in the component object.
Copy link
Member

Choose a reason for hiding this comment

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

#chat is not a value from asyncapi document but rather a name for a chat channel that you use in article to probably reference too slack channels, or in general channel chat concept, so instead of code from markdown probably leave it without anything or in bold. You use it several times in article, pick one way and be consistent

derberg
derberg reviewed Dec 9, 2024
View reviewed changes
markdown/blog/asyncapi-and-websocket.md
chatMessage:
$ref: '#/components/messages/chat'

userStatus: #newly added channel message
Copy link
Member

Choose a reason for hiding this comment

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

instead of adding comment you can use CodeBlock component like https://github.com/asyncapi/website/blob/master/markdown/docs/tutorials/getting-started/servers.md?plain=1#L14

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

@derberg derberg derberg left review comments

@devilkiller-ag devilkiller-ag Awaiting requested review from devilkiller-ag

@sambhavgupta0705 sambhavgupta0705 Awaiting requested review from sambhavgupta0705

@BhaswatiRoy BhaswatiRoy Awaiting requested review from BhaswatiRoy

@J0SAL J0SAL Awaiting requested review from J0SAL

@TRohit20 TRohit20 Awaiting requested review from TRohit20

@VaishnaviNandakumar VaishnaviNandakumar Awaiting requested review from VaishnaviNandakumar

@thulieblack thulieblack Awaiting requested review from thulieblack thulieblack will be requested when the pull request is marked ready for review thulieblack is a code owner

@quetzalliwrites quetzalliwrites Awaiting requested review from quetzalliwrites quetzalliwrites will be requested when the pull request is marked ready for review quetzalliwrites is a code owner

@akshatnema akshatnema Awaiting requested review from akshatnema akshatnema will be requested when the pull request is marked ready for review akshatnema is a code owner

@magicmatatjahu magicmatatjahu Awaiting requested review from magicmatatjahu magicmatatjahu will be requested when the pull request is marked ready for review magicmatatjahu is a code owner

@anshgoyalevil anshgoyalevil Awaiting requested review from anshgoyalevil anshgoyalevil will be requested when the pull request is marked ready for review anshgoyalevil is a code owner

@Mayaleeeee Mayaleeeee Awaiting requested review from Mayaleeeee Mayaleeeee will be requested when the pull request is marked ready for review Mayaleeeee is a code owner

@asyncapi-bot-eve asyncapi-bot-eve Awaiting requested review from asyncapi-bot-eve asyncapi-bot-eve will be requested when the pull request is marked ready for review asyncapi-bot-eve is a code owner

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.
2 participants
@AceTheCreator @derberg