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: broken link to generator github actions (Fixes #3190) #3217

Merged
merged 4 commits into from
Dec 16, 2024

Conversation

hkv24
Copy link
Contributor

@hkv24 hkv24 commented Sep 11, 2024

Description
This PR fixes a broken link in the AsyncAPI Generator Installation Guide. The outdated link to the GitHub Marketplace Action for AsyncAPI documents needs to be updated with the correct URL.

Current Link: https://github.com/marketplace/actions/generator-for-asyncapi-documents
Updated Link: https://github.com/marketplace/actions/generator-validator-converter-and-others-all-in-one-for-your-asyncapi-docs

Resolves #3190

Summary by CodeRabbit

  • Documentation
    • Updated links and descriptions in the AsyncAPI GitHub Actions documentation to reflect current offerings.
    • Revised the "Happy Birthday AsyncAPI" document to include new links and npm scope updates for React and Web components.
    • Added details about AsyncAPI Special Interest Group meetings and additional reading resources.

Copy link

netlify bot commented Sep 11, 2024

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 9cea3f0
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/67600b253ea53a0008b29de2
😎 Deploy Preview https://deploy-preview-3217--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.

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Sep 11, 2024

⚡️ Lighthouse report for the changes in this PR:

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

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

@sambhavgupta0705
Copy link
Member

@TRohit20 can you please take a look

Copy link
Collaborator

@TRohit20 TRohit20 left a comment

Choose a reason for hiding this comment

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

Thanks for noticing and fixing the broken link @hkv24

LGTM! @sambhavgupta0705

@hkv24
Copy link
Contributor Author

hkv24 commented Sep 15, 2024

@TRohit20 No worries man!
Thanks for approving my PR

@sambhavgupta0705
Copy link
Member

@quetzalliwrites PTAL

Copy link

coderabbitai bot commented Nov 7, 2024

Walkthrough

The pull request includes updates to two markdown documents related to AsyncAPI, primarily focusing on correcting links and descriptions for GitHub Actions. The links have been changed to reflect a new generator action, and additional information regarding npm scopes for React and web components has been added. The overall structure of the documents remains the same, with no changes made to the YAML examples.

Changes

File Change Summary
markdown/blog/asyncapi-github-actions.md Updated links to the GitHub Actions generator from generator-for-asyncapi-documents to generator-validator-converter-and-others-all-in-one-for-your-asyncapi-docs.
markdown/blog/status-update-47-20.md Updated links in the GitHub Action section and introduced new npm scopes for React and web components.

Assessment against linked issues

Objective Addressed Explanation
Update broken link to GitHub Actions (Issue #3190)

Possibly related PRs

Suggested labels

ready-to-merge, autoapproved

Suggested reviewers

  • sambhavgupta0705
  • TRohit20
  • quetzalliwrites
  • akshatnema
  • devilkiller-ag
  • Mayaleeeee
  • BhaswatiRoy
  • asyncapi-bot-eve

🐰 In the garden, links were lost,
But now they shine, no matter the cost.
AsyncAPI's actions, clear and bright,
With updates made, all feels right!
Hopping through docs, we celebrate,
A joyful fix, oh, isn’t it great? 🌼


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.

Copy link

codecov bot commented Nov 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.59%. Comparing base (4f9e745) to head (9cea3f0).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3217   +/-   ##
=======================================
  Coverage   86.59%   86.59%           
=======================================
  Files          21       21           
  Lines         664      664           
=======================================
  Hits          575      575           
  Misses         89       89           

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

Copy link
Member

@anshgoyalevil anshgoyalevil left a comment

Choose a reason for hiding this comment

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

Thanks @hkv24
🚢

@sambhavgupta0705
Copy link
Member

/update

@sambhavgupta0705
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit dc7d0d3 into asyncapi:master Dec 16, 2024
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs Bug 🐞 report]: Broken link to Generator Github Actions
7 participants