Skip to content

Conversation

@derberg
Copy link
Member

@derberg derberg commented Oct 28, 2024

Also adding alt text on request of one sponsor

Summary by CodeRabbit

  • New Features

    • Updated altText for the sponsor "Bump.sh" to provide clearer context.
    • Added new entries for Adidas and Morgan Stanley in the adopters list, highlighting their use of AsyncAPI.
  • Bug Fixes

    • Removed outdated entries for several companies in the adopters list to ensure accuracy.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 28, 2024

Walkthrough

The changes include an update to the altText property for the sponsor "Bump.sh" in the SilverSponsorsList.ts file, changing its description to provide more detailed information. Additionally, the adopters.yml file underwent significant modifications, with multiple companies removed and two new entries added for Adidas and Morgan Stanley, detailing their use of AsyncAPI and providing relevant resource links.

Changes

File Path Change Summary
components/sponsors/SilverSponsorsList.ts Updated altText for "Bump.sh" from 'Bump' to 'OpenAPI & AsyncAPI API docs - Bump.sh'.
config/adopters.yml Removed multiple entries (e.g., Reiffeisen Bank, LEGO Group) and added two new entries for Adidas and Morgan Stanley, including resource links.

Poem

In the meadow where sponsors play,
"Bump.sh" shines bright, leading the way.
With Adidas and Morgan, new tales unfold,
AsyncAPI's magic, a sight to behold!
Out with the old, in with the new,
Hopping along, we celebrate too! 🐇✨


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
Copy link

netlify bot commented Oct 28, 2024

Deploy Preview for asyncapi-website ready!

Name Link
🔨 Latest commit ace7de8
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/671fa404485afa0008e6729e
😎 Deploy Preview https://deploy-preview-3338--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
Copy link

codecov bot commented Oct 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 49.14%. Comparing base (d7ee919) to head (ace7de8).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3338   +/-   ##
=======================================
  Coverage   49.14%   49.14%           
=======================================
  Files          21       21           
  Lines         647      647           
=======================================
  Hits          318      318           
  Misses        329      329           

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

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Oct 28, 2024

⚡️ Lighthouse report for the changes in this PR:

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

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (2)
components/sponsors/SilverSponsorsList.ts (1)

Line range hint 1-54: Consider standardizing alt text descriptions across all sponsors.

While the new alt text for Bump.sh is more descriptive, there's inconsistency in alt text style across sponsors. Most sponsors use just the brand name, while Bump.sh and Route4Me have descriptive texts. Consider standardizing the approach for all sponsors to maintain consistency and improve accessibility throughout.

Example format suggestions:

  • Option 1 (Brand + Description): "[Brand Name] - [Service Description]"
  • Option 2 (Brand Only): Just the brand name if it's a well-known company

This would help maintain a consistent user experience for screen reader users.

config/adopters.yml (1)

85-89: Polish the use case description for better readability.

The current description uses fragmented sentences. Consider rewording for better flow:

-  useCase: AsyncAPI is a standard for defining asynchronous APIs using Apache Kafka. AsyncAPI governed under official guidelines. AsyncAPI is promoted to be used for documentation and code generation.
+  useCase: At Adidas, AsyncAPI serves as the standard for defining asynchronous APIs using Apache Kafka. Following official guidelines, we promote its use for documentation and code generation.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7c27ab6 and e1d794a.

📒 Files selected for processing (2)
  • components/sponsors/SilverSponsorsList.ts (1 hunks)
  • config/adopters.yml (1 hunks)
🧰 Additional context used
🪛 yamllint
config/adopters.yml

[error] 95-95: no new line character at the end of file

(new-line-at-end-of-file)

🔇 Additional comments (2)
components/sponsors/SilverSponsorsList.ts (1)

7-7: LGTM! Improved alt text for better accessibility.

The updated alt text provides more descriptive information about the Bump.sh service, which improves accessibility for screen readers.

config/adopters.yml (1)

Line range hint 1-83: Verify the intentional removal of existing adopters.

The changes remove 12 company entries including major adopters like Walmart, eBay, and Adobe. Since the PR objective only mentions adding Adidas and Morgan Stanley, please confirm if removing the existing adopters was intentional.

🧰 Tools
🪛 yamllint

[error] 95-95: no new line character at the end of file

(new-line-at-end-of-file)

@derberg derberg changed the title chore: add Adidas and Stanley Morgan to list of adopters chore: add Adidas and Morgan Stanley to list of adopters Oct 28, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)
config/adopters.yml (3)

85-86: Improve clarity of the use case description.

The current description contains sentence fragments and redundant mentions. Consider revising for better clarity:

- useCase: AsyncAPI is a standard for defining asynchronous APIs using Apache Kafka. AsyncAPI governed under official guidelines. AsyncAPI is promoted to be used for documentation and code generation.
+ useCase: We use AsyncAPI as our standard for defining asynchronous APIs with Apache Kafka. The implementation follows official guidelines, and we promote its use for both documentation and code generation.

91-92: Enhance use case description with implementation details.

The current description focuses on promotion but lacks technical details. Consider adding information about the WebSocket implementation mentioned in the resource:

- useCase: AsyncAPI is promoted not only inside the company but also as a standard for FinOS Foundation for managing architecture as code.
+ useCase: We implement and promote AsyncAPI across the company, particularly for WebSocket-based services, while also advocating for it as a standard within the FinOS Foundation for managing architecture as code.

89-89: Consider hosting presentation content on a more stable platform.

Several resources link to Google Drive presentations, which may have access control issues or become inaccessible. Consider:

  1. Hosting the content on a more stable platform (e.g., company website, GitHub)
  2. Providing alternative formats (e.g., blog posts, documentation)

Also applies to: 95-95

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between e1d794a and 4775890.

📒 Files selected for processing (1)
  • config/adopters.yml (1 hunks)

Copy link
Member

@sambhavgupta0705 sambhavgupta0705 left a comment

Choose a reason for hiding this comment

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

LGTM ㊗️

@akshatnema
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit 7753444 into asyncapi:master Oct 28, 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.

5 participants