fix(migrating-to-v3): fix mark down to ensure correct highlighting #3268
Conversation
GuillaumeGayot
requested review from
quetzalliwrites and
asyncapi-bot-eve
as code owners
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
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.
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
asyncapi-bot
requested review from
devilkiller-ag,
sambhavgupta0705,
BhaswatiRoy,
J0SAL,
TRohit20 and
VaishnaviNandakumar
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-3268--asyncapi-website.netlify.app/ |
GuillaumeGayot
force-pushed
the
master
branch
from
04c2e78 to
c17c142
Compare
WalkthroughThe changes in this pull request focus on updating the migration documentation for AsyncAPI from version 2 to version 3. Key modifications include restructuring metadata, splitting the Server Object URL into distinct properties, and decoupling operations, channels, and messages. Additionally, operation keywords have been updated, and the message structure has been revised to enhance clarity and usability. The documentation reflects these breaking changes and provides guidance on the new schema and properties introduced in AsyncAPI v3. Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3268 +/- ##
=======================================
Coverage 86.59% 86.59%
=======================================
Files 21 21
Lines 664 664
=======================================
Hits 575 575
Misses 89 89 ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- markdown/docs/migration/migrating-to-v3.md (2 hunks)
🔇 Additional comments (1)
markdown/docs/migration/migrating-to-v3.md (1)
268-271: Changes align with PR objectives.The indentation fixes in both v2 and v3 OAuth examples will help ensure proper markdown highlighting, which aligns with the PR's objective of fixing highlighting issues in the documentation.
Also applies to: 294-297
|
@GuillaumeGayot can you please add the |
|
/update |
Description
by adding quotes we fix the highlighting of the markdown in the documentation
Related issue(s)
Resolve #3007
Summary by CodeRabbit